Referência da API
Selecione a superfície da API, o modelo de autorização e o chamador corretos para cada fluxo de integração.
Nesta página
A DEUNA oferece APIs públicas para backends de lojistas, aplicações de clientes, parceiros e callbacks de provedores. Comece pelo tipo de consumidor, não apenas pelo nome do recurso, pois o modelo de autorização muda conforme a interface. APIs internas de administração e gestão são excluídas intencionalmente.
Use a Catálogo completo de endpoints Para pesquisar todas as operações configuradas do API Gateway por consumidor pretendido, serviço proprietário, autorização ou cabeçalho.
URLs base#
Use o URL base do sandbox durante o desenvolvimento. Mude para a produção somente após receber as credenciais de produção e concluir a certificação.
Selecione a superfície da API#
| Superfície | Chamador pretendido | Autorização | Utilize-o para |
|---|---|---|---|
| Backend do comerciante · comunicação entre servidores | Infraestrutura de comerciante confiável | Chave API privada em X-Api-Key; X-Store-Code e cabeçalhos idempotentes, quando necessário | Pedidos, compras, capturas, reembolsos, cancelamentos, consentimento e leituras operacionais |
| Aplicativo do cliente · comunicação entre servidor e usuário | Aplicativo web ou móvel do comerciante em nome de um cliente | Contexto de aplicação público mais usuário Authorization: Bearer … Após o login; nunca inclua uma chave privada | Login, perfil, endereços, cartões armazenados e fluxos de pagamento autorizados pelo cliente |
| Backend da rede ou parceiro | Integração da rede ou plataforma aprovada | Credenciais do parceiro e contexto do tenant/rede definidos durante o onboarding | Pedidos e relatórios em escala de rede, configuração e relatórios |
| Callback do provedor · provedor para a DEUNA | Provedor de pagamento, prevenção de fraude, carteira ou plataforma | Contrato de callback específico do provedor; o Gateway encaminha os cabeçalhos de callback para o serviço proprietário e não declara um validador de credenciais compartilhado | Notificações de status assíncronas; os sistemas do comerciante não devem chamar essas rotas |
Autenticação#
Backend do comerciante
Envie a chave API privada em X-Api-Key, não no cabeçalho Bearer. Mantenha-a na infraestrutura do servidor confiável.
X-Api-Key: YOUR_PRIVATE_API_KEY
X-Store-Code: STORE_CODE
X-Idempotency-Key: order_1042-attempt_1
Content-Type: application/jsonCliente autenticado
Envie o token de acesso do usuário no cabeçalho Bearer. Algumas operações de pedido e carteira também podem exigir a chave de aplicação do comerciante ou o contexto da loja; catálogo de endpoints Mostra os cabeçalhos de autorização e encaminhamento para cada rota.
Authorization: Bearer USER_ACCESS_TOKEN
X-Api-Key: APPLICATION_API_KEY
X-Store-Code: STORE_CODE
Content-Type: application/jsonParceiros
As credenciais do parceiro e o contexto de rede são fornecidos durante o onboarding. Não use uma chave privada da API de checkout como credencial de parceiro.
Consulte Autenticação Para gerenciamento de credenciais, tempo de vida dos tokens e rotação.
Operações do backend do comerciante#
Operações do aplicativo do cliente#
Callbacks do provedor#
As rotas de callback do provedor fazem parte do inventário completo, permitindo que as equipes identifiquem a propriedade e evitem chamá-las acidentalmente. Não são webhooks do comerciante. Para receber eventos da DEUNA no seu próprio backend, configure a URL do webhook do pedido e siga Webhooks.
Respostas e erros#
Navegue pela lista completa em Códigos de erro.
Controle de versão de caminho#
Use cada caminho exatamente como publicado. O API Gateway frequentemente expõe rotas canônicas sem um interno /api/v1 prefixo. Um segmento de versão como /v2 está incluído apenas quando faz parte da via pública mostrada no catálogo. As alterações compatíveis com versões anteriores estão listadas no Registro de alterações.