> ## 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. # Configurar programa de afiliados do produto > Liga o programa de afiliados de um produto da empresa autenticada e define comissão, aprovação manual, exposição no marketplace e repasse de estorno; os campos omitidos ficam como estão. Recusa com 400 um percentual que zeraria o produtor em alguma oferta depois da taxa da plataforma. Responde 404 quando o produto pertence a outra empresa. ## OpenAPI ````yaml /openapi.yaml patch /v1/products/{productId}/affiliation-settings 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/products/{productId}/affiliation-settings: patch: tags: - Crescimento summary: Configurar programa de afiliados do produto description: >- Liga o programa de afiliados de um produto da empresa autenticada e define comissão, aprovação manual, exposição no marketplace e repasse de estorno; os campos omitidos ficam como estão. Recusa com 400 um percentual que zeraria o produtor em alguma oferta depois da taxa da plataforma. Responde 404 quando o produto pertence a outra empresa. operationId: updateProductAffiliationSettings parameters: - schema: type: string minLength: 1 in: path name: productId required: true description: Identificador do produto. requestBody: required: true content: application/json: schema: type: object properties: acceptAffiliates: type: boolean description: Liga ou desliga o programa de afiliados do produto. requireAffiliateApproval: type: boolean description: Exige aprovação manual de cada pedido de afiliação. wantToReceiveEmails: type: boolean description: Avisa o produtor por e-mail a cada novo pedido. affiliateDataAccess: type: boolean description: Dá ao afiliado acesso aos dados do comprador. listedOnMarketplace: type: boolean description: Publica o produto na vitrine do marketplace. supportEmailAffiliate: type: string format: email description: E-mail de suporte. descriptionAffiliate: type: string maxLength: 1000 description: Apresentação do produto para o afiliado. commissionAffiliate: type: integer minimum: 0 maximum: 100 description: Percentual de comissão do afiliado, de 0 a 100. passRefundToAffiliates: type: boolean description: >- Desconta a comissão do afiliado quando a venda é reembolsada. additionalProperties: false example: acceptAffiliates: true commissionAffiliate: 40 listedOnMarketplace: true responses: '200': description: Configuração de afiliação já atualizada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: acceptAffiliates: type: boolean description: >- Se o produto aceita afiliados. Com `false`, ninguém novo consegue se afiliar. requireAffiliateApproval: type: boolean description: >- Se cada pedido de afiliação espera aprovação manual em vez de já nascer aprovado. wantToReceiveEmails: type: boolean description: >- Se o produtor recebe e-mail a cada novo pedido de afiliação. affiliateDataAccess: type: boolean description: >- Se o afiliado enxerga os dados do comprador das vendas que gerou. listedOnMarketplace: type: boolean description: >- Se o produto aparece na vitrine pública do marketplace. supportEmailAffiliate: type: string nullable: true description: E-mail de suporte exibido ao afiliado. descriptionAffiliate: type: string nullable: true description: >- Texto que apresenta o produto ao afiliado no marketplace. commissionAffiliate: type: integer nullable: true description: >- Percentual de comissão do afiliado sobre o preço da oferta, de 0 a 100. slugOfferProduct: type: string nullable: true description: >- Slug público do produto, usado no marketplace e nos links de divulgação. passRefundToAffiliates: type: boolean description: >- Se o estorno de uma venda reembolsada desconta a comissão do afiliado. required: - acceptAffiliates - requireAffiliateApproval - wantToReceiveEmails - affiliateDataAccess - listedOnMarketplace - supportEmailAffiliate - descriptionAffiliate - commissionAffiliate - slugOfferProduct - passRefundToAffiliates additionalProperties: false required: - success - data additionalProperties: false description: Configuração de afiliação já atualizada. example: success: true data: acceptAffiliates: true requireAffiliateApproval: true wantToReceiveEmails: true affiliateDataAccess: false listedOnMarketplace: true supportEmailAffiliate: afiliados@exemplo.com.br descriptionAffiliate: >- Produto validado, com página de vendas pronta e criativos liberados. commissionAffiliate: 40 slugOfferProduct: trafego-pago passRefundToAffiliates: true '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 ````