Autenticação
Esta documentação descreve o processo de autenticação para integração com a API OpenDelivery.
Visão Geral
A API utiliza autenticação baseada em token OAuth 2.0 com o fluxo de credenciais de cliente (client_credentials), projetado especificamente para comunicações entre servidores (server-to-server).
Processo Básico
- Obtenha suas credenciais de acesso (client_id e client_secret)
- Solicite um token de acesso via POST para
/opendelivery/oauth/token - Utilize o token recebido no header
Authorization: Bearer {token}para requisições subsequentes
Tokens e Acesso a Módulos
O token JWT gerado contém informações sobre:
- Identificadores do cliente e estabelecimento
- Módulos da API que o cliente tem permissão para acessar
- Tempo de expiração (7 dias)
Tipos de Clientes
A API suporta diferentes tipos de clientes com níveis de acesso variados:
Parceiros Integrados
Parceiros oficialmente integrados possuem acesso ampliado à API com maiores limites de uso e podem acessar funcionalidades adicionais baseadas em seu nível de parceria.
Os parceiros integrados recebem credenciais específicas que determinam seu acesso:
client_id: identificador único do parceiroclient_secret: token de autenticação específico do parceiro
Segurança
Recomendamos as seguintes práticas para proteger suas credenciais e tokens:
- Armazenar credenciais em variáveis de ambiente ou sistemas seguros de gerenciamento de segredos
- Nunca incluir credenciais em código-fonte ou repositórios públicos
- Implementar mecanismos de renovação automática de token antes da expiração
- Utilizar conexões HTTPS para todas as requisições
Documentação de Referência
Para detalhes completos sobre parâmetros, formatos de requisição e resposta, consulte: