Skip to main content
POST
Liga uma plataforma de venda ao club

Authorizations

Authorization
string
header
required

Token OPACO de sessão de quem administra, emitido por /v1/auth/admin/sign-in e verificado contra a nossa tabela — o mesmo desenho do studentSession, para a outra identidade.

É o esquema de quem ADMINISTRA — o dashboard. O aluno do classroom usa o studentSession; uma rota consumida pelos dois declara os dois esquemas, e o middleware aceita qualquer um deles. As duas credenciais são opacas e chegam pelo mesmo cabeçalho: quem as separa é a tabela em que cada uma existe.

O dashboard o guarda em cookie httpOnly, que o BFF troca pelo Authorization a cada chamada.

Path Parameters

clubId
string<uuid>
required

Id público da organização — o mesmo que GET /v1/me devolve em organization_id.

Na URL o recurso se chama club; no contrato e no domínio, organization. A divergência é deliberada: clubs é a palavra do produto, e a URL é o que as pessoas leem.

É o identificador do provedor de autenticação, e é assim de propósito: o cliente precisa nomear a organização ao pedir o token, e o token é o que prova o escopo. Um id só nosso obrigaria a traduzir um no outro antes de ter um token — e a tradução exigiria uma chamada escopada, que é justamente a que ainda não dá para fazer.

O uuid interno da organização não aparece no contrato: ele é o que as chaves estrangeiras do domínio referenciam, e continua sendo nosso.

Body

application/json
platform
enum<string>
required

As plataformas de venda que a API entende. guru é o Digital Manager Guru; webhook é o formato genérico, para gateways e automatizadores sem integração nativa.

Available options:
hotmart,
kiwify,
eduzz,
guru,
webhook
secret
string
required

O que a plataforma manda para provar que é ela. Guardado cifrado; não sai mais.

Required string length: 8 - 512
display_name
string

Para distinguir duas contas da mesma plataforma na tela.

Maximum string length: 120

Response

Conexão criada. A URL só aparece aqui.

data
object
required