> ## Documentation Index
> Fetch the complete documentation index at: https://docs.centralcart.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Affiliate Panel
> Painel do afiliado: comissão, saldo, totais e links de indicação.
O campo `status` diz em que ponto o cliente está. `affiliate` traz os dados completos; `not_affiliate` significa que ele ainda pode se cadastrar; `restricted` que a loja não aceita cadastro por conta própria. Os dois últimos vêm com `200` porque não são erro, e é com eles que você decide se mostra o convite para participar.
## OpenAPI
````yaml /openapi/storefront-affiliate.yaml get /webstore/affiliate/me
openapi: 3.1.0
info:
title: CentralCart Storefront API (Afiliados)
version: 1.0.0
description: >-
Programa de afiliados da loja, na visão do comprador que indica. Todas as
rotas exigem a sessão do cliente, exceto a que resolve um código de
indicação.
servers:
- url: https://api.centralcart.io/v1
description: Produção
security:
- customerAuth: []
paths:
/webstore/affiliate/me:
get:
tags:
- Afiliados
summary: Get Affiliate Panel
description: >-
Painel do afiliado: comissão, saldo, totais e links de indicação.
O campo `status` diz em que ponto o cliente está. `affiliate` traz
os dados completos; `not_affiliate` significa que ele ainda pode se
cadastrar; `restricted` que a loja não aceita cadastro por conta
própria. Os dois últimos vêm com `200` porque não são erro, e é com eles
que você decide se mostra o convite para participar.
operationId: getWebstoreAffiliatePanel
parameters:
- $ref: '#/components/parameters/StoreDomain'
- name: include_visits
in: query
required: false
description: >-
Quando `true`, preenche `stats.d7_visits` e o `d7_visits` de cada
link com as visitas dos últimos 7 dias. Deixa a resposta mais lenta,
então só peça quando for exibir esse número.
schema:
type: boolean
responses:
'200':
description: Situação do cliente no programa de afiliados
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AffiliatePanel'
- $ref: '#/components/schemas/AffiliateNotJoined'
examples:
Afiliado:
summary: Já é afiliado
value:
status: affiliate
id: 42
name: João
email: comprador@example.com
ref_code: joao
percent_commission: 10
balance: 189.6
min_withdraw: 50
withdraw_settings:
full_name: João da Silva
pix_key: comprador@example.com
pix_key_type: EMAIL
cpf_cnpj: '12345678900'
stats:
total_sales: 12
total_amount: 1896
d7_visits: null
links:
- id: 7
name: Link principal
ref_code: joao
url: https://minhaloja.centralcart.com/?ref=joao
sales: 12
revenue: 1896
d7_visits: null
Pode se cadastrar:
summary: Ainda não é afiliado
value:
status: not_affiliate
Cadastro fechado:
summary: Loja não aceita cadastro por conta própria
value:
status: restricted
'401':
$ref: '#/components/responses/CustomerUnauthorized'
'404':
description: A loja não tem programa de afiliados configurado
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
errors:
- message: Configurações de afiliado não encontradas para esta loja.
components:
parameters:
StoreDomain:
name: x-store-domain
in: header
required: true
description: 'Domínio da sua loja (ex: sualoja.centralcart.ai)'
schema:
type: string
schemas:
AffiliatePanel:
type: object
properties:
status:
type: string
enum:
- affiliate
id:
type: number
name:
type: string
email:
type: string
ref_code:
type: string
description: Código principal do afiliado, usado em `?ref=`.
percent_commission:
type: number
description: Percentual de comissão padrão deste afiliado.
balance:
type: number
description: Saldo disponível para saque.
min_withdraw:
type: number
nullable: true
description: Valor mínimo por saque. `null` usa o padrão da loja.
withdraw_settings:
$ref: '#/components/schemas/WithdrawSettings'
stats:
type: object
properties:
total_sales:
type: number
description: Pedidos aprovados atribuídos a este afiliado.
total_amount:
type: number
description: Soma dos pedidos aprovados atribuídos a este afiliado.
d7_visits:
type: number
nullable: true
description: Visitas dos últimos 7 dias. Só vem com `include_visits=true`.
links:
type: array
items:
$ref: '#/components/schemas/AffiliateLink'
AffiliateNotJoined:
type: object
properties:
status:
type: string
enum:
- not_affiliate
- restricted
description: >-
`not_affiliate`: o cliente pode se cadastrar. `restricted`: a loja
não aceita cadastro por conta própria.
Error:
type: object
properties:
errors:
type: array
items:
type: object
properties:
message:
type: string
code:
type: string
ref:
type: string
WithdrawSettings:
type: object
nullable: true
required:
- full_name
- pix_key
- pix_key_type
- cpf_cnpj
properties:
full_name:
type: string
pix_key:
type: string
pix_key_type:
type: string
enum:
- CPF
- CNPJ
- EMAIL
- PHONE
- RANDOM
cpf_cnpj:
type: string
AffiliateLink:
type: object
properties:
id:
type: number
name:
type: string
ref_code:
type: string
url:
type: string
description: Link pronto para compartilhar.
sales:
type: number
description: Vendas acumuladas por este link.
revenue:
type: number
description: Receita acumulada por este link.
d7_visits:
type: number
nullable: true
description: >-
Visitas dos últimos 7 dias. Só vem preenchido em `GET
/webstore/affiliate/me` com `include_visits=true`; nos demais casos
é `null`.
responses:
CustomerUnauthorized:
description: Sessão do cliente ausente, inválida ou expirada
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
errors:
- message: Sessão inválida ou expirada.
code: CUSTOMER_UNAUTHENTICATED
securitySchemes:
customerAuth:
type: http
scheme: bearer
description: '`access_token` do comprador, devolvido por `POST /webstore/auth/verify`.'
````