> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Conectar integração > Conecta um aplicativo externo à empresa autenticada informando as credenciais que aquele provedor exige. A credencial é validada junto ao provedor na hora: uma chave recusada não vira conexão. Use ao provisionar uma conta nova pelo seu próprio sistema, sem passar pela tela Aplicativos. Telegram e Discord não entram aqui — eles se conectam pelo código do bot. ## OpenAPI ````yaml /openapi.yaml post /v1/integrations/{provider} openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/integrations/{provider}: post: tags: - Plataforma summary: Conectar integração description: >- Conecta um aplicativo externo à empresa autenticada informando as credenciais que aquele provedor exige. A credencial é validada junto ao provedor na hora: uma chave recusada não vira conexão. Use ao provisionar uma conta nova pelo seu próprio sistema, sem passar pela tela Aplicativos. Telegram e Discord não entram aqui — eles se conectam pelo código do bot. operationId: createIntegration parameters: - schema: type: string enum: - memberkit - cademi - spedy - reportana - utmify - metrito in: path name: provider required: true description: >- Aplicativo a conectar: `memberkit`, `cademi`, `spedy`, `reportana`, `utmify` ou `metrito`. requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 description: Apelido da conexão, exibido no cartão do aplicativo. apiKey: type: string minLength: 1 description: >- Credencial do provedor: API Key da MemberKit ou da Spedy, token da Cademi ou da UTMify, connection key da Metrito. subdomain: type: string minLength: 1 description: Subdomínio da área de membros, exigido pela Cademi. clientId: type: string minLength: 1 description: Client ID do app, exigido pela Reportana. clientSecret: type: string minLength: 1 description: Client Secret do app, exigido pela Reportana. description: type: string description: Observação livre sobre a conexão. active: type: boolean description: Conectar já ativo (`true`) ou pausado (`false`). productIds: type: array items: type: string pattern: ^[cC][^\s-]{8,}$ description: >- Produtos que esta conexão passa a acompanhar. Produto de outra empresa responde 400. paymentMethods: type: array items: type: string enum: - pix - credit_card - boleto - multiple_cards description: >- Meio de pagamento registrado na venda. Inclui `boleto`, que só aparece em vendas antigas: a plataforma não emite novas cobranças nesse trilho. description: >- Formas de pagamento que disparam o envio ao provedor. Vendas antigas em `boleto` também disparam. paymentStatus: type: array items: type: string enum: - pending - infraction - paid - refused - canceled - refund - chargeback - contest - preCharge - error - waiting - expired description: Situações de venda que disparam o envio ao provedor. additionalProperties: false example: name: Área de membros Curso de Confeitaria apiKey: mk_live_7f3c1b9a2d5e4f6081c2 responses: '201': description: Conexão criada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: id: type: string description: >- Identificador da conexão nesta plataforma, usado para atualizar, pausar ou desconectar. provider: type: string enum: - memberkit - cademi - spedy - notazz - reportana - utmify - metrito - voxuy - astrofy - telegram - discord description: >- Aplicativo externo: `memberkit`, `cademi`, `spedy`, `notazz`, `reportana`, `utmify`, `metrito`, `voxuy`, `astrofy`, `telegram` ou `discord`. name: type: string nullable: true description: >- Apelido dado à conexão, ou o nome do canal/servidor vinculado. active: type: boolean description: >- `false` quando a conexão está pausada, removida ou sem permissão no provedor. status: type: string nullable: true description: >- Situação relatada pelo provedor (`active`, `bot_removed`, `missing_permissions`). `null` onde não se aplica. externalId: type: string nullable: true description: >- Identificador no provedor: `chatId` do Telegram, id do servidor Discord, subdomínio da Cademi. hasCredentials: type: boolean description: >- `true` quando há credencial do provedor guardada. O segredo em si nunca é devolvido. productIds: type: array items: type: string description: >- Produtos já vinculados a esta conexão, quando o provedor aceita vínculo. createdAt: type: string format: date-time description: Momento em que a conexão foi criada. updatedAt: type: string format: date-time description: Momento da última alteração. required: - id - provider - name - active - status - externalId - hasCredentials - productIds - createdAt - updatedAt additionalProperties: false required: - success - data additionalProperties: false description: Conexão criada. example: success: true data: id: clx9m4t7p0001qz0a5r3d8k2v provider: memberkit name: Área de membros Curso de Confeitaria active: true status: null externalId: null hasCredentials: true productIds: [] createdAt: '2026-08-02T14:21:00.000Z' updatedAt: '2026-09-01T09:35:00.000Z' '400': description: A requisição está bem formada, mas uma regra de negócio a recusou. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- A requisição está bem formada, mas uma regra de negócio a recusou. example: success: false message: >- Não foi possível concluir: uma regra de negócio recusou os dados enviados. '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````