Pular para o conteúdo principal
Nesta página

A referência da API da DEUNA abrange as operações de backend do lojista e de aplicativos do cliente publicadas na documentação anterior. Comece pelo chamador, não apenas pelo nome do recurso, pois o modelo de autorização compatível muda conforme a superfície. As outras rotas do API Gateway são intencionalmente excluídas desta referência.

Use a navegação da Referência da API para explorar as operações publicadas por área de produto e recurso.

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.

Sandbox
https://api.sandbox.deuna.io
Produção
https://api.deuna.io

Selecione a superfície da API#

SuperfícieChamador pretendidoAutorizaçãoUtilize-o para
Backend do comerciante · comunicação entre servidoresInfraestrutura de comerciante confiávelChave API privada em X-Api-Key; X-Store-Code e cabeçalhos idempotentes, quando necessárioPedidos, compras, capturas, reembolsos, cancelamentos e consultas operacionais
Aplicativo do cliente · comunicação entre servidor e usuárioAplicativo web ou móvel do comerciante em nome de um clienteContexto de aplicação público mais usuário Authorization: Bearer … Após o login; nunca inclua uma chave privadaLogin opcional, perfis e endereços reutilizáveis e cartões armazenados

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.

Cabeçalhos de solicitação do servidor para servidorHTTP
X-Api-Key: YOUR_PRIVATE_API_KEY
X-Store-Code: STORE_CODE
X-Idempotency-Key: order_1042-attempt_1
Content-Type: application/json

Cliente autenticado

Envie o token de acesso do usuário no cabeçalho Bearer. Algumas operações de pedidos e carteiras também exigem a chave do aplicativo do lojista ou o contexto da loja; a página de cada operação lista sua autorização e os cabeçalhos encaminhados.

Cabeçalhos de requisição do usuário para o servidorHTTP
Authorization: Bearer USER_ACCESS_TOKEN
X-Api-Key: APPLICATION_API_KEY
X-Store-Code: STORE_CODE
Content-Type: application/json

Veja 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#

Respostas e erros#

2xxA solicitação foi bem-sucedida.
4xxAutenticação, permissões, estado ou dados de solicitação devem mudar. Inspecione o código de erro retornado.
5xxDEUNA ou um provedor falhou. Tente novamente somente quando a operação for idempotente, usando a mesma chave de idempotência.

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.