> ## 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. # Simular comissão de afiliado > Simula, sem gravar nada, quanto sobra para o produtor e quanto vai para o afiliado numa oferta com um percentual candidato de comissão, já descontada a taxa real da Ephra. Chame antes de salvar o percentual para não descobrir só depois que a conta não fecha. ## OpenAPI ````yaml /openapi.yaml get /v1/products/{productId}/affiliation-settings/commission-preview 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/commission-preview: get: tags: - Crescimento summary: Simular comissão de afiliado description: >- Simula, sem gravar nada, quanto sobra para o produtor e quanto vai para o afiliado numa oferta com um percentual candidato de comissão, já descontada a taxa real da Ephra. Chame antes de salvar o percentual para não descobrir só depois que a conta não fecha. operationId: previewAffiliateCommission parameters: - schema: type: integer exclusiveMinimum: true minimum: 0 in: query name: offerId required: true description: Oferta do produto usada como base do cálculo. - schema: type: number minimum: 0 maximum: 100 in: query name: commissionAffiliate required: true description: Percentual de comissão a simular, de 0 a 100. Não grava nada. - schema: type: string minLength: 1 in: path name: productId required: true description: Identificador do produto. responses: '200': description: Comparação entre venda direta e venda por afiliado. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: price: type: integer description: Preço da oferta em centavos (R$ 499,00 = 49900). platformFee: type: integer description: >- Taxa da Ephra sobre a oferta, em centavos, no cenário PIX à vista. withoutAffiliate: type: object properties: producerAmount: type: integer description: >- Quanto sobra para o produtor sem afiliado, em centavos. required: - producerAmount additionalProperties: false description: Cenário de venda direta. withAffiliate: type: object properties: affiliateAmount: type: integer description: Quanto vai para o afiliado, em centavos. producerAmount: type: integer description: Quanto sobra para o produtor, em centavos. required: - affiliateAmount - producerAmount additionalProperties: false description: >- Cenário de venda por afiliado com o percentual simulado. required: - price - platformFee - withoutAffiliate - withAffiliate additionalProperties: false required: - success - data additionalProperties: false description: Comparação entre venda direta e venda por afiliado. example: success: true data: price: 49900 platformFee: 2495 withoutAffiliate: producerAmount: 47405 withAffiliate: affiliateAmount: 19960 producerAmount: 27445 '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 ````