/
Documentação Listar pedidos , leads e consulta financeira - Manual API Relatório

Documentação Listar pedidos , leads e consulta financeira - Manual API Relatório

Passo a Passo: Listando Pedidos, Leads e Consultas Financeiras via API REST

Requisições POST devem ter o header “Content-Type“ com o valor “application/vnd.api+json“ para evitar erros na criação de itens

Variáveis (Postman)

  • {{url}} → Base URL da API.

  • {{token}} → Token gerado pela autenticação.


🔐 Autenticação

Antes de acessar os relatórios, é necessário se logar com usuário e senha (Do painel Datacake).
O sistema gera um código de acesso temporário (token), que será usado em todas as consultas seguintes.

💡 Após autenticar com sucesso e gerar o token, você conseguirá listar, consultar e realizar todas as ações restantes via API

 

Coleção utilizada (Postman)



🔹(POSTMAN) Autenticação

Curl:

curl --location '/api/token/' \ --header 'accept: application/vnd.api+json' \ --header 'content-type: application/vnd.api+json' \ --data '{ "username_or_email": "", "password": "" }'

Endpoint:

POST {{url}}/api/token/

Headers:

  • accept: application/vnd.api+json

  • content-type: application/vnd.api+json

Body (JSON):

{ "username_or_email": "string", "password": "string" }

Use as mesmas credenciais (usuário e senha) do seu login no painel da Datacake.

Resposta esperada:
⚠️ Atenção: o token de autenticação possui um tempo de validade. Após expirar, será necessário realizar uma nova autenticação, que gerará um novo token. Por isso, o token exibido nos exemplos pode ser diferente do que você receberá.

image-20250821-200119.png

 

Pedidos (Orders)

Aqui estão os relatórios relacionados aos pedidos de clientes.

  • Buscar Pedidos → Lista de todos os pedidos registrados.

    • Possível filtrar por quantidade de registros por página ou trazer informações adicionais, como endereço de cobrança, envio, cliente e produtos do pedido.

  • Buscar Pedido por ID → Mostra os detalhes de um pedido específico, ideal para verificar status ou informações de um cliente em particular.


🔹(POSTMAN) Buscar Pedidos

 

Curl:

curl --location '/api/store/order/' \ --header 'Authorization: Bearer ' \ --header 'Accept: application/vnd.api+json' \ --header 'Content-Type: application/vnd.api+json'

Endpoint:

GET {{url}}/api/store/order/

Headers:

  • Authorization: Bearer {{token}}

  • Accept: application/vnd.api+json

  • Content-Type: application/vnd.api+json

Query Params (opcionais):

  • page[number] → número da página

  • page[size] → quantidade por página

  • include → expandir dados relacionados (billing_address, shipping_address, user, lines)

 

🔹(POSTMAN) Buscar Pedido por ID

Endpoint:

GET {{url}}/api/store/order/{id}/

Descrição: Retorna os detalhes de um pedido específico.

Leads

Os leads representam os potenciais clientes (cadastros, interessados, consultas).

  • Buscar Leads → Lista todos os leads cadastrados no sistema.

    • É possível ver dados como: nome, bairro, cidade, CPF/CNPJ, origem do lead e situação atual.

  • Buscar Lead por ID → Mostra os detalhes de um lead específico, útil quando se deseja consultar apenas um cadastro em profundidade.

🔹(POSTMAN) Buscar Leads

 

Curl:

curl --location '/api/provider/lead/' \ --header 'Authorization: Bearer ' \ --header 'Accept: application/vnd.api+json' \ --header 'Content-Type: application/vnd.api+json'

Endpoint:

GET {{url}}/api/provider/lead/

Headers: iguais.

Query Params (opcionais):

  • page[number]

  • page[size]

  • include → (lead_event, financial_consultation)

🔹(POSTMAN) Buscar Lead por ID

Endpoint:

GET {{url}}/api/provider/lead/{id}/

Descrição: Retorna os detalhes de um lead específico.

Consultas Financeiras

Esses relatórios estão ligados à análise de crédito financeiro dos clientes.

  • Buscar Consultas Financeiras → Lista todas as consultas já realizadas.

    • Mostra dados como: documento do cliente, pontuação de crédito, resultado da análise e status do pedido vinculado.

  • Buscar Consulta Financeira por ID → Exibe os detalhes de uma consulta em específico, para checar a situação financeira de um cliente individual.

 

🔹(POSTMAN) Buscar Consultas Financeiras

 

Curl:

curl --location '/api/financial-consultation/consultation/?include=order' \ --header 'Authorization: Bearer ' \ --header 'Accept: application/vnd.api+json' \ --header 'Content-Type: application/vnd.api+json'

Endpoint:

GET {{url}}/api/financial-consultation/consultation/?include=order

Headers: iguais.

Query Params (Obrigatório):

  • include=order

Query Params (opcionais):

  • page[number]

  • page[size]

  • fields → (id, customer_document_number, score, order, order__status, result, created)

 

🔹(POSTMAN) Buscar Consulta Financeira por ID

Endpoint:

GET {{url}}/api/financial-consultation/consultation/{id}/?include=order

Descrição: Retorna detalhes de uma consulta financeira específica.