Skip to main content
Os endpoints de cliente permitem consultar informações do usuário autenticado, incluindo saldo de pontos, histórico de transações e pontos a expirar.

​
Status de Autenticação dos Endpoints

EndpointStatus
GET /pub/widget/customer/pointsAutenticado
GET /pub/widget/customer/infoAutenticado
GET /pub/widget/customer/historyAutenticado
POST /pub/widget/customer/setbirthdayAutenticado
GET /pub/widget/customer/expiringpointsAutenticado

​
Consultar Saldo de Pontos

Retorna o saldo de pontos do cliente autenticado.

​
Requisição

GET /pub/widget/customer/points 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/customer/points" \
  -H "X-Bq-Tenant: {tenant_key}" \
  -H "X-Bq-SecureToken: {secure_token}"

​
Resposta

​
HasError
boolean
Indica se houve erro na requisição.
​
Item
object
{
  "HasError": false,
  "Message": null,
  "Item": {
    "PointsBalance": 1500
  }
}

​
Consultar Informações do Cliente

Retorna informações detalhadas do cliente autenticado, incluindo saldo, tier atual e status de afiliado.

​
Requisição

GET /pub/widget/customer/info 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/customer/info" \
  -H "X-Bq-Tenant: {tenant_key}" \
  -H "X-Bq-SecureToken: {secure_token}"

​
Resposta

​
HasError
boolean
Indica se houve erro na requisição.
​
Item
object
{
  "HasError": false,
  "Message": null,
  "Item": {
    "PointsBalance": 1500,
    "PointsText": "1.500 pontos",
    "Name": "João Silva",
    "CurrentTier": {
      "Id": 1,
      "Name": "Gold",
      "Color": "#FFD700"
    },
    "IsAffiliate": false,
    "LastPointUpdateDate": "2025-02-01T10:30:00Z"
  }
}

​
Consultar Histórico de Pontos

Retorna o histórico de transações de pontos do cliente com paginação.

​
Requisição

GET /pub/widget/customer/history Headers
​
X-Bq-Tenant
string
required
Identificador público da loja.
​
X-Bq-SecureToken
string
required
Token do usuário obtido no login seguro.
Query Parameters
​
page
integer
required
Número da página (começa em 0 ou 1).

​
Exemplo

curl -X GET "https://api.bonifiq.com.br/pub/widget/customer/history?page=1" \
  -H "X-Bq-Tenant: {tenant_key}" \
  -H "X-Bq-SecureToken: {secure_token}"

​
Resposta

​
HasError
boolean
Indica se houve erro na requisição.
​
Item
object
{
  "HasError": false,
  "Message": null,
  "Item": {
    "Items": [
      {
        "Id": 12345,
        "Type": 1,
        "Title": "Compra #ABC123",
        "Points": 150,
        "Value": 150.00,
        "Date": "2025-02-01T10:30:00Z",
        "OrderState": 2,
        "CancelledDate": null,
        "OriginalId": "ABC123",
        "CouponCode": null,
        "HasCouponCode": false,
        "CustomIcon": null,
        "IsCanceled": false
      },
      {
        "Id": 12344,
        "Type": 2,
        "Title": "Resgate de recompensa",
        "Points": -100,
        "Value": null,
        "Date": "2025-01-28T14:20:00Z",
        "OrderState": null,
        "CancelledDate": null,
        "OriginalId": null,
        "CouponCode": "DESCONTO10",
        "HasCouponCode": true,
        "CustomIcon": null,
        "IsCanceled": false
      }
    ],
    "TotalPages": 5,
    "TotalItems": 47
  }
}

​
Definir Data de Aniversário

Permite ao cliente definir ou atualizar sua data de aniversário para receber benefícios especiais.

​
Requisição

POST /pub/widget/customer/setbirthday Headers
​
X-Bq-Tenant
string
required
Identificador público da loja.
​
X-Bq-SecureToken
string
required
Token do usuário obtido no login seguro.
Query Parameters
​
birthday
string
required
Data de aniversário no formato dd/MM ou yyyy-MM-dd.

​
Exemplo

curl -X POST "https://api.bonifiq.com.br/pub/widget/customer/setbirthday?birthday=15/03" \
  -H "X-Bq-Tenant: {tenant_key}" \
  -H "X-Bq-SecureToken: {secure_token}"

​
Resposta

{
  "HasError": false,
  "Message": "Aniversário atualizado com sucesso",
  "Item": null
}
A data de aniversário geralmente só pode ser definida uma vez. Verifique as regras do programa de fidelidade.

​
Consultar Pontos a Expirar

Retorna a lista de pontos que estão próximos de expirar.

​
Requisição

GET /pub/widget/customer/expiringpoints 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/customer/expiringpoints" \
  -H "X-Bq-Tenant: {tenant_key}" \
  -H "X-Bq-SecureToken: {secure_token}"

​
Resposta

​
HasError
boolean
Indica se houve erro na requisição.
​
Item
array
Lista de lotes de pontos a expirar.
{
  "HasError": false,
  "Message": null,
  "Item": [
    {
      "Id": 1001,
      "Value": 200,
      "Date": "2025-03-15"
    },
    {
      "Id": 1002,
      "Value": 150,
      "Date": "2025-04-01"
    }
  ]
}
Use esta informação para alertar o cliente sobre pontos prestes a expirar e incentivá-lo a utilizá-los.