Skip to main content
Os endpoints de afiliados permitem consultar informações e histórico do cliente quando ele participa do programa de afiliados.

Status de Autenticação dos Endpoints

EndpointStatus
GET /pub/widget/affiliate/infohistoryAutenticado

Consultar Histórico de Afiliado

Retorna o histórico e informações do cliente como afiliado.

Requisição

GET /pub/widget/affiliate/infohistory Headers
X-Bq-Tenant
string
required
Identificador público da loja.
X-Bq-SecureToken
string
required
Token do usuário obtido no login seguro.

Exemplo

curl -X GET "https://api.bonifiq.com.br/pub/widget/affiliate/infohistory" \
  -H "X-Bq-Tenant: {tenant_key}" \
  -H "X-Bq-SecureToken: {secure_token}"

Resposta

{
  "HasError": false,
  "Message": null,
  "Item": {
    "IsAffiliate": true,
    "AffiliateCode": "AFF123",
    "TotalEarnings": 1500.00,
    "PendingEarnings": 250.00,
    "TotalOrders": 45,
    "ConversionRate": 12.5,
    "History": [
      {
        "Date": "2025-02-01",
        "OrderId": "ORD-001",
        "Value": 150.00,
        "Commission": 15.00,
        "Status": "Paid"
      },
      {
        "Date": "2025-01-28",
        "OrderId": "ORD-002",
        "Value": 200.00,
        "Commission": 20.00,
        "Status": "Pending"
      }
    ]
  }
}
O programa de afiliados permite que clientes ganhem comissões por indicar novos compradores. Para verificar se um cliente é afiliado, você também pode usar o campo IsAffiliate no endpoint /pub/widget/customer/info.