Este guia apresenta o processo completo para integrar um sistema externo à API Pública do Jão Delivery, desde a geração do token até a realização das primeiras consultas de dados. O objetivo é orientar desenvolvedores na criação de integrações seguras e eficientes com a plataforma.
Toda integração com a API requer um token de autenticação. Esse token identifica o restaurante e autoriza o acesso aos dados.
Faça login no painel administrativo do Jão Delivery.
No menu lateral, acesse API PĆŗblica.
Clique em Gerar Novo Token.
Copie o token gerado e armazene-o em local seguro.
O sistema permite gerar múltiplos tokens para diferentes integrações ou ambientes. Tokens também podem ser revogados a qualquer momento caso seja necessÔrio interromper o acesso de alguma aplicação.
Todas as requisições para a API devem incluir o token no header de autorização.
Authorization: Bearer <seu_api_token>
Se o token estiver ausente, invƔlido ou revogado, a API retornarƔ:
401 Unauthorized
Isso garante que apenas sistemas autorizados possam acessar os dados do restaurante.
Todas as requisiƧƵes devem utilizar a seguinte base:
https://api.jao.app
Os endpoints são acessados a partir dessa URL base.
Exemplo de endpoint completo:
https://api.jao.app/public/products
Para validar a integração, o primeiro teste recomendado é consultar os produtos do cardÔpio.
GET /public/products
const token = 'SEU_TOKEN_AQUI';
const response = await fetch('https://api.jao.app/public/products?page=1&limit=10', {
headers: {
'Authorization': `Bearer ${token}`,
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);
Essa requisição retorna uma lista paginada de produtos cadastrados no restaurante.
As consultas da API utilizam paginação para evitar respostas muito grandes.
Parâmetro
Descrição
page | PƔgina da consulta (comeƧa em 1) |
limit | Quantidade de itens retornados |
GET /public/products?page=1&limit=10
A resposta inclui metadados que ajudam a navegar entre pĆ”ginas, como total de registros e total de pĆ”ginas disponĆveis.
Após validar a conexão com os produtos, o próximo passo é consultar os pedidos do restaurante.
GET /public/requests
Esse endpoint retorna os pedidos realizados no restaurante.
GET /public/requests?page=1&limit=20
O endpoint de pedidos permite aplicar filtros que ajudam a refinar as consultas.
status=all
status=success
status=canceled
status=preparing
period=today
period=yesterday-today
period=all
period=7
Exemplo de consulta:
GET /public/requests?status=success&period=7
Essa consulta retorna pedidos concluĆdos dos Ćŗltimos 7 dias.
O endpoint de produtos permite buscar itens do cardÔpio utilizando o parâmetro search.
GET /public/products?search=pizza
Essa consulta retorna produtos cujo nome contenha o termo pesquisado.
As respostas da API seguem uma estrutura padronizada que inclui:
mensagem da operação
lista de registros
informações de paginação
dados agregados quando disponĆveis
Exemplo simplificado:
{
"message": "success",
"docs": [],
"totalDocs": 120,
"limit": 10,
"page": 1,
"totalPages": 12,
"hasPrevPage": false,
"hasNextPage": true
}
No caso de pedidos, tambƩm pode existir um objeto summary, contendo totais e mƩtricas relacionadas aos pedidos retornados.
Para facilitar o desenvolvimento da integração, a API disponibiliza uma documentação interativa baseada em Swagger.
https://api.jao.app/api-public
https://api.jao.app/api-public-json
O Swagger permite:
visualizar todos os endpoints disponĆveis
testar requisiƧƵes diretamente no navegador
verificar schemas de request e response
validar parâmetros antes de implementar a integração no código.
Para garantir uma integração estÔvel e segura, recomenda-se:
armazenar tokens em variƔveis de ambiente
nunca expor tokens no frontend pĆŗblico
implementar tratamento de erros HTTP
utilizar paginação para grandes volumes de dados
validar respostas antes de processar dados
A integração com a API Pública do Jão Delivery é simples e segue um modelo padrão de APIs REST modernas.
Com autenticação via token, endpoints organizados e documentação Swagger disponĆvel, desenvolvedores podem rapidamente integrar sistemas externos para acessar dados de pedidos e produtos, permitindo automação, anĆ”lise e integração com outras ferramentas do ecossistema digital do restaurante.