Coleção Postman

A coleção Postman do EloFiel permite testar todos os endpoints da API sem escrever uma linha de código.

Disponibilidade futura

O arquivo .json da coleção Postman será disponibilizado para download em uma versão futura desta documentação. Enquanto isso, use os exemplos abaixo para configurar manualmente.

Configurando o ambiente no Postman

1. Criar um Environment

1. Abra o Postman
2. Clique em Environments no painel esquerdo
3. Clique em + para criar um novo ambiente
4. Nomeie como "EloFiel Sandbox"
5. Adicione as seguintes variáveis:

Variável	Valor inicial	Descrição
base_url	https://api-sandbox.elofiel.com.br	URL base da API
api_key	(sua_api_key_aqui)	Chave de autenticação PDV
cnpj_loja	12.345.678/0001-90	CNPJ do seu estabelecimento
cpf_cliente_teste	123.456.789-09	CPF para testes

6. Clique em Save

2. Usar variáveis nas requisições

No Postman, referencie as variáveis com {{nome_variavel}}:

POST {{base_url}}/api/v1/venda

Headers:

Content-Type: application/json
X-Api-Key: {{api_key}}

---

Requisições de referência

POST /api/v1/venda

URL: {{base_url}}/api/v1/venda Método: POST Headers:

• Content-Type: application/json
• X-Api-Key: {{api_key}}

Body (raw JSON):

{
  "cnpjLoja": "{{cnpj_loja}}",
  "cpfCliente": "{{cpf_cliente_teste}}",
  "valorVenda": 150.00,
  "documentoExterno": "POSTMAN-001",
  "observacao": null
}

GET /api/v1/resgate/saldo

URL: {{base_url}}/api/v1/resgate/saldo Método: GET Headers:

• X-Api-Key: {{api_key}}

Params:

• cnpjLoja: {{cnpj_loja}}
• cpfCliente: {{cpf_cliente_teste}}

POST /api/v1/resgate

URL: {{base_url}}/api/v1/resgate Método: POST Headers:

• Content-Type: application/json
• X-Api-Key: {{api_key}}

Body (raw JSON):

{
  "cnpjLoja": "{{cnpj_loja}}",
  "cpfCliente": "{{cpf_cliente_teste}}",
  "tipoBeneficio": "Cashback",
  "valorResgate": 10.00,
  "pontosResgate": null,
  "documentoExterno": "POSTMAN-002",
  "observacao": null
}

GET /api/v1/configuracao

URL: {{base_url}}/api/v1/configuracao Método: GET Headers:

• X-Api-Key: {{api_key}}

Params:

• cnpjLoja: {{cnpj_loja}}

POST /api/v1/cliente

URL: {{base_url}}/api/v1/cliente Método: POST Headers:

• Content-Type: application/json
• X-Api-Key: {{api_key}}

Body (raw JSON):

{
  "cpf": "{{cpf_cliente_teste}}",
  "nome": "Cliente Teste",
  "email": "teste@email.com",
  "telefone": "44999990000",
  "aceiteLgpd": true
}

POST /api/v1/authadmin/login

URL: {{base_url}}/api/v1/authadmin/login Método: POST Headers:

• Content-Type: application/json

Body (raw JSON):

{
  "email": "gestor@loja.com.br",
  "senha": "sua_senha_aqui"
}

---

Dicas de uso no Postman

Script para salvar o token automaticamente

Após o login, adicione este script na aba Tests da requisição de login:

const resultado = pm.response.json();

if (resultado.sucesso && resultado.dados?.token) {
  pm.environment.set('jwt_token', resultado.dados.token);
  console.log('Token salvo no ambiente.');
}

Depois, use {{jwt_token}} no header Authorization: Bearer {{jwt_token}} nas requisições admin.

Verificação automática da resposta

Adicione na aba Tests de qualquer requisição:

pm.test('Resposta deve ter sucesso: true', () => {
  const resultado = pm.response.json();
  pm.expect(resultado.sucesso).to.be.true;
});

pm.test('Status HTTP deve ser 200', () => {
  pm.response.to.have.status(200);
});