> ## 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.

# Vincular produto ao canal

> Faz um produto liberar acesso ao canal, servidor ou turma assim que a venda é aprovada — o convite do Telegram, o cargo do Discord, a matrícula na turma da área de membros. É o segundo e último passo da entrega automática. Um produto de outra empresa responde 400; um canal de outra empresa, 404.



## OpenAPI

````yaml /openapi.yaml post /v1/integrations/{provider}/channels/{channelId}/products
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}/channels/{channelId}/products:
    post:
      tags:
        - Plataforma
      summary: Vincular produto ao canal
      description: >-
        Faz um produto liberar acesso ao canal, servidor ou turma assim que a
        venda é aprovada — o convite do Telegram, o cargo do Discord, a
        matrícula na turma da área de membros. É o segundo e último passo da
        entrega automática. Um produto de outra empresa responde 400; um canal
        de outra empresa, 404.
      operationId: mapChannelProduct
      parameters:
        - schema:
            type: string
            enum:
              - telegram
              - discord
              - cademi
              - memberkit
          in: path
          name: provider
          required: true
          description: >-
            Provedor do destino: `telegram` (canal), `discord` (servidor),
            `cademi` (turma da área de membros) ou `memberkit` (turma da área de
            membros).
        - schema:
            type: string
            minLength: 1
          in: path
          name: channelId
          required: true
          description: >-
            Identificador do canal, servidor, conta Cademi ou conexão Memberkit
            nesta plataforma — o `id` devolvido por `listIntegrations`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                productId:
                  type: string
                  pattern: ^[cC][^\s-]{8,}$
                  description: >-
                    Produto que passa a liberar acesso. Produto de outra empresa
                    responde 400.
                roleId:
                  type: string
                  minLength: 1
                  description: >-
                    Cargo do servidor dado ao comprador. Obrigatório no
                    `discord`, ignorado nos demais.
                externalId:
                  type: string
                  minLength: 1
                  description: >-
                    Identificador do produto ou turma no provedor. Obrigatório
                    na `cademi` (id do produto lá) e na `memberkit` (id numérico
                    da turma, de `listMemberkitClassrooms`); ignorado nos
                    demais.
              required:
                - productId
              additionalProperties: false
            example:
              productId: clx8a2h4k0001qz0a1b2c3d4e
              roleId: '1287654321098765432'
      responses:
        '201':
          description: Vínculo criado.
          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 do vínculo, usado para desfazê-lo.
                      channelId:
                        type: string
                        description: Canal, servidor ou turma que este vínculo libera.
                      productId:
                        type: string
                        description: Produto cuja venda aprovada libera o acesso.
                      productName:
                        type: string
                        nullable: true
                        description: Nome do produto, para conferência.
                      roleId:
                        type: string
                        nullable: true
                        description: >-
                          Cargo dado ao comprador no servidor Discord. `null`
                          nos demais provedores.
                      roleName:
                        type: string
                        nullable: true
                        description: >-
                          Nome do cargo no momento do vínculo. `null` nos demais
                          provedores.
                      externalId:
                        type: string
                        nullable: true
                        description: >-
                          Identificador do produto no provedor. Preenchido na
                          `cademi`.
                      createdAt:
                        type: string
                        format: date-time
                        description: Momento em que o vínculo foi criado.
                    required:
                      - id
                      - channelId
                      - productId
                      - productName
                      - roleId
                      - roleName
                      - externalId
                      - createdAt
                    additionalProperties: false
                required:
                  - success
                  - data
                additionalProperties: false
                description: Vínculo criado.
              example:
                success: true
                data:
                  id: clxa1b2c30001qz0a7h4k9m3n
                  channelId: clx9z8y7x0001qz0a2f5g6h7j
                  productId: clx8a2h4k0001qz0a1b2c3d4e
                  productName: Curso de Confeitaria Artesanal
                  roleId: '1287654321098765432'
                  roleName: Alunos
                  externalId: null
                  createdAt: '2026-09-04T18:12: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
        '404':
          description: O recurso não existe, foi excluído ou pertence a outra empresa.
          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: >-
                  O recurso não existe, foi excluído ou pertence a outra
                  empresa.
              example:
                success: false
                message: Recurso não encontrado
        '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

````