A API Pública do Jão Delivery permite que sistemas externos consultem dados de restaurantes cadastrados na plataforma. O objetivo principal é possibilitar integrações com sistemas de gestão, ferramentas de análise, dashboards, automações e outras aplicações que necessitem consumir informações operacionais do delivery.

Este artigo apresenta uma visão técnica da API, descrevendo autenticação, estrutura de consultas, recursos disponíveis e organização das respostas.

1. Autenticação

O acesso à API pública é realizado por meio de token de autenticação.

Cada restaurante pode gerar seus próprios tokens diretamente no painel administrativo. Esse token funciona como uma chave de autorização que identifica o restaurante e permite o acesso aos dados vinculados a ele.

Geração do token

O token é gerado dentro do painel administrativo na seção API Pública. O sistema permite a criação de múltiplos tokens, possibilitando diferentes integrações simultâneas.

Revogação de token

Tokens podem ser revogados a qualquer momento pelo painel. Após revogado, o token deixa de ser válido para qualquer requisição.

Essa funcionalidade permite controle de segurança caso um token seja comprometido ou uma integração deixe de ser utilizada.

Uso do token nas requisições

Todas as rotas da API exigem autenticação via header Authorization no formato Bearer Token.

Estrutura do header:

Authorization: Bearer <seu_api_token>

Caso o token esteja ausente, inválido ou revogado, a API retorna status HTTP 401 (Unauthorized).

2. Estrutura da API

A API pública é organizada em um grupo principal de consultas, permitindo acesso aos dados operacionais do restaurante.

Atualmente estão disponíveis dois recursos principais:

Recurso

Descrição

Todos os dados retornados nas consultas estão limitados ao restaurante associado ao token utilizado na requisição.

3. Recursos disponíveis

3.1 Pedidos

Endpoint responsável pela consulta de pedidos realizados no restaurante.

Endpoint

GET /public/requests

Parâmetros de consulta

Parâmetro

Descrição

Filtros disponíveis

Parâmetro

Valores

Exemplo de uso do filtro de período:

• period=7 → retorna pedidos dos últimos 7 dias.

Esses filtros permitem realizar consultas específicas, facilitando análises operacionais e relatórios de vendas.

Informações retornadas

A resposta da API inclui:

• lista de pedidos

• dados de paginação

• objeto de resumo com totais

O objeto summary apresenta agregações importantes como:

• total de valores

• quantidade de pedidos

• pedidos por status

Essas informações permitem calcular métricas como faturamento, volume de pedidos e desempenho operacional.

3.2 Produtos

Endpoint responsável pela consulta de produtos cadastrados no cardápio do restaurante.

Endpoint

GET /public/products

Parâmetros de consulta

Parâmetro

Descrição

Busca por produto

A API permite buscar produtos pelo nome utilizando o parâmetro:

search

Esse parâmetro recebe uma string e retorna produtos que correspondem ao termo pesquisado.

Esse recurso pode ser utilizado em integrações que necessitem sincronizar ou indexar o cardápio do restaurante.

4. Paginação

Todos os endpoints de listagem utilizam paginação padrão, permitindo consultas escaláveis e controle sobre grandes volumes de dados.

Parâmetros

Parâmetro

Descrição

Metadados de paginação

A resposta inclui metadados que auxiliam na navegação entre páginas:

Campo

Descrição

Esses metadados permitem implementar navegação eficiente entre grandes volumes de dados.

5. Estrutura das respostas

As respostas da API seguem um padrão estruturado contendo:

• mensagem da operação

• dados retornados

• metadados de paginação

• objetos de resumo quando aplicável

Estrutura geral:

{
  "message": "...",
  "docs": [],
  "totalDocs": ...,
  "limit": ...,
  "page": ...,
  "totalPages": ...,
  "hasPrevPage": ...,
  "hasNextPage": ...
}

Essa padronização facilita o consumo da API por diferentes aplicações e frameworks.

6. Documentação interativa (Swagger)

A API possui documentação interativa baseada em Swagger/OpenAPI, que permite explorar todos os endpoints diretamente pelo navegador.

A documentação inclui:

• definição completa dos endpoints

• parâmetros de requisição

• schemas de request e response

• exemplos de payload

• códigos de status possíveis

URLs da API em produção:

Base da API:

https://api.jao.app

Swagger UI:

https://api.jao.app/api-public

OpenAPI JSON:

https://api.jao.app/api-public-json

A utilização do Swagger é recomendada para validar parâmetros, testar endpoints e compreender a estrutura das respostas antes de iniciar uma integração.

7. Casos de uso técnicos

A API pública pode ser utilizada em diversos cenários de integração, como:

Integração com sistemas ERP

Sincronização automática de pedidos para sistemas de gestão financeira ou contábil.

Business Intelligence (BI)

Alimentação de dashboards e plataformas analíticas com dados operacionais do restaurante.

Automação de processos

Criação de rotinas automáticas para monitoramento de vendas, geração de relatórios e alertas operacionais.

Sincronização de cardápio

Integração com outros canais ou plataformas que necessitam acessar os produtos cadastrados.

Conclusão

A API Pública do Jão Delivery fornece uma interface padronizada para acesso programático aos dados do restaurante.

Com autenticação via token, endpoints estruturados e respostas padronizadas, a API permite que desenvolvedores integrem facilmente o sistema com outras aplicações, ampliando as possibilidades de análise, automação e gestão de dados no ecossistema do delivery.