Autenticação e Formato das Requisições
Todas as requisições à API exigem autenticação obrigatória do estabelecimento. Essa autenticação deve ser feita utilizando dois tokens:
- App Token: identifica a aplicação que está fazendo a requisição.
- Access Token: concede as permissões específicas para o estabelecimento em questão.
Ambos os tokens devem ser enviados nos cabeçalhos da requisição HTTP, conforme o exemplo abaixo:
Exemplo de Requisição com Autenticação
http
GET https://integracao.fidelizii.com.br/api/v3/estabelecimentos HTTP/1.1
Host: integracao.fidelizii.com.br
app-token: {APP_TOKEN}
access-token: {APP_TOKEN}
Content-Type: application/json
Formato das Respostas
Todas as respostas da API são retornadas no formato JSON e acompanham os respectivos códigos de status HTTP, garantindo clareza e padronização na comunicação.
Exemplo de Resposta com Sucesso
json
{
"success": true,
"data": [
{
"id": 1,
"nome": "João da Silva",
"telefone": "11999999999"
}
]
}
Exemplo de Resposta com Erro de Autenticação (401 Unauthorized)
json
{
"error": "Acesso negado."
}
Segurança da Comunicação
⚠️ Atenção: Todas as requisições devem ser feitas obrigatoriamente via HTTPS.
Requisições feitas via HTTP (sem criptografia) não são aceitas e receberão erro de resposta.