> ## Documentation Index > Fetch the complete documentation index at: https://docs.weve.cx/llms.txt > Use this file to discover all available pages before exploring further. # Ligar plataforma > Cria a conexão e devolve, uma única vez, a URL para colar no painel da plataforma. ## OpenAPI ````yaml POST /v1/clubs/{clubId}/sales-platform-connections openapi: 3.0.3 info: title: weve API description: > Contrato entre a API Go e o dashboard. **Este arquivo é a fonte de verdade**: os tipos e a interface de servidor em Go, e o client TypeScript, são todos gerados daqui (`make openapi`). Handler que divergir da interface não compila. A superfície interna (`/internal/*`) fica de fora de propósito: é acesso de máquina, protegido por segredo dedicado, e não é contrato de cliente. version: 0.2.0 servers: - url: https://api.weve.cx description: produção - url: http://localhost:8080 description: desenvolvimento security: [] tags: - name: health - name: session - name: account - name: clubs - name: members - name: webhooks - name: sales-platforms - name: catalog - name: content - name: classroom - name: students - name: auth paths: /v1/clubs/{clubId}/sales-platform-connections: parameters: - $ref: '#/components/parameters/OrgId' post: tags: - sales-platforms summary: Liga uma plataforma de venda ao club description: | Cria a conexão e devolve, **uma única vez**, a URL que o gestor cola no painel da plataforma. O token dentro dela fica guardado como hash, e o segredo cifrado — nenhum dos dois pode ser lido depois. Perdeu a URL? Desliga esta conexão e cria outra. O `secret` é o que a plataforma usa para provar que é ela: o hottok da Hotmart, a chave de assinatura da Kiwify, a origin key da Eduzz, o Account Token do Guru (Minha Conta › API — o da CONTA, que vai em todo webhook; não o token de usuário, que é para chamar a API deles), ou o Bearer que o integrador vai mandar no webhook genérico. Exige permissão de administração do club. operationId: createSalesPlatformConnection requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SalesPlatformConnectionCreate' responses: '201': description: Conexão criada. A URL só aparece aqui. content: application/json: schema: $ref: '#/components/schemas/SalesPlatformConnectionCreatedResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '422': $ref: '#/components/responses/UnprocessableEntity' '429': $ref: '#/components/responses/TooManyRequests' '500': $ref: '#/components/responses/InternalError' '501': $ref: '#/components/responses/NotConfigured' security: - userSession: [] components: parameters: OrgId: name: clubId in: path required: true description: > 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. schema: type: string format: uuid schemas: SalesPlatformConnectionCreate: type: object required: - platform - secret properties: platform: $ref: '#/components/schemas/SalesPlatform' display_name: type: string maxLength: 120 description: Para distinguir duas contas da mesma plataforma na tela. secret: type: string minLength: 8 maxLength: 512 description: | O que a plataforma manda para provar que é ela. Guardado cifrado; não sai mais. SalesPlatformConnectionCreatedResponse: type: object required: - data properties: data: $ref: '#/components/schemas/SalesPlatformConnectionCreated' SalesPlatform: type: string enum: - hotmart - kiwify - eduzz - guru - webhook description: | 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. SalesPlatformConnectionCreated: allOf: - $ref: '#/components/schemas/SalesPlatformConnection' - type: object required: - webhook_url properties: webhook_url: type: string description: | A URL para colar no painel da plataforma. Só aparece nesta resposta: o token dentro dela é guardado como hash. ErrorEnvelope: type: object description: >- Envelope único de erro da API. O `code` é o contrato com o cliente — a `message` é diagnóstico, e pode mudar. required: - error properties: error: type: object required: - code properties: code: type: string message: type: string SalesPlatformConnection: type: object required: - id - platform - active - created_at properties: id: type: string format: uuid platform: $ref: '#/components/schemas/SalesPlatform' display_name: type: string active: type: boolean last_event_at: type: string format: date-time description: Última vez que a plataforma chamou esta URL. Ausente até a primeira. created_at: type: string format: date-time responses: BadRequest: description: Requisição malformada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Unauthorized: description: Sessão ausente, expirada ou revogada content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' Forbidden: description: > A sessão é válida, mas não age nesta organização. É a mesma resposta para uma organização que não existe — distinguir as duas deixaria enumerar organizações alheias. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' UnprocessableEntity: description: Campos obrigatórios ausentes ou inválidos content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' TooManyRequests: description: Teto por IP atingido headers: Retry-After: schema: type: integer content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' InternalError: description: >- Falha inesperada. O corpo nunca traz o erro real — ele fica no log e no rastreamento. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' NotConfigured: description: | O ambiente não tem o que a operação precisa (`not_configured`): o provedor de autenticação nas rotas de sessão, o e-mail nas que enviam link, a chave de cifra nos webhooks. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: userSession: type: http scheme: bearer description: | 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. ```` ## Related topics - [Weve DRM](/essentials/watermark.md) - [Receber evento de plataforma](/api-reference/webhooks/receive.md) - [Mapear id de plataforma](/api-reference/catalog/products-external-id.md) - [Listar conexões](/api-reference/webhooks/connections-list.md) - [Histórico de eventos](/api-reference/webhooks/events-list.md)