Introdução

A OlaClick Public API permite que parceiros e desenvolvedores integrem com a plataforma OlaClick de forma programática — consultar menus, ler pedidos e receber notificações de eventos em tempo real via webhooks.

URL Base

https://public-api.olaclick.app

Todos os endpoints são servidos sob o prefixo de path /v1 (ex.: GET /v1/orders).

Autenticação

Todos os endpoints exigem uma API Key. Envie-a em um destes headers:

Authorization: Bearer olk_live_...

X-API-Key: olk_live_...

As API Keys são geradas no painel do restaurante em Integrations > API Keys.

Scopes

As permissões da API Key são controladas por scopes atribuídos no momento da criação:

Scope	Permissão
`menu:read`	Ler o catálogo (categorias, produtos, variantes)
`menu:write`	Criar/atualizar produtos
`orders:read`	Ler pedidos
`clients:read`	Ler dados de clientes
`reports:read`	Ler relatórios e analytics
`webhooks:read`	Ler assinaturas de webhook
`webhooks:write`	Criar/atualizar/excluir assinaturas de webhook
`companies:read`	Ler informações da empresa
`payment-methods:read`	Ler os métodos de pagamento da empresa

Formato de resposta

Todas as respostas bem-sucedidas são encapsuladas em um envelope data:

{
  "data": { ... }
}

Para endpoints de listagem, paginação e metadados são incluídos:

{
  "data": [ ... ],
  "pagination": {
    "current_page": 1,
    "per_page": 50,
    "total": 230,
    "has_more": true
  }
}

Convenção de parâmetros de consulta

Inspirada em JSON:API:

Filtragem:

GET /v1/orders?filter[status]=pending&filter[start_date]=2026-01-01&filter[end_date]=2026-01-31

Paginação:

GET /v1/orders?page=1&per_page=50

Ordenação (prefixo - = descendente):

GET /v1/orders?sort=-created_at

Erros

As respostas de erro usam RFC 7807 Problem Details (não encapsuladas em data):

{
  "type": "https://api.olaclick.com/errors/insufficient_scope",
  "title": "Insufficient Scope",
  "status": 403,
  "detail": "The API key does not have the required scope: orders:read",
  "instance": "/v1/orders"
}

Limitação de taxa

As requisições são limitadas por API key de acordo com o tier. Os headers de resposta indicam seu uso atual:

RateLimit-Limit: 100
RateLimit-Remaining: 97
RateLimit-Reset: 1719000000

Quando o limite é excedido, a API retorna 429 Too Many Requests com um header Retry-After.

Próximos passos

→ Primeiros Passos — Faça sua primeira chamada à API em 5 minutos.

Escolha seu caminho de integração

	Public API	OlaClick Hub
Para	Uma única empresa integrando seus próprios sistemas	Desenvolvedores criando produtos para múltiplas empresas
Autenticação	API Key (gerada a partir do seu painel OlaClick)	OAuth 2.1 client credentials
Acesso	Os dados da sua própria empresa	Os dados de qualquer empresa conectada
Exemplo	Conectar seu PDV aos seus próprios pedidos OlaClick	Criar um app de analytics de entregas usado por centenas de restaurantes

Integração de uma única empresa

Se você está conectando seus próprios sistemas (PDV, ERP, dashboard personalizado) à sua conta OlaClick, a Public API com uma API Key é tudo o que você precisa. Gere uma chave no seu painel e comece a fazer requisições.

Plataforma multiempresa

Se você está criando uma aplicação que outras empresas OlaClick podem instalar e usar, confira o OlaClick Hub. O Hub oferece acesso baseado em OAuth a múltiplas empresas, gerenciamento de conexões e um modelo de integração padronizado.

Quando sua aplicação estiver pronta, você pode passar pelo nosso processo de homologação para publicá-la no marketplace da OlaClick — tornando-a disponível para milhares de restaurantes na América Latina.

URL Base​

Autenticação​

Scopes​

Formato de resposta​

Convenção de parâmetros de consulta​

Erros​

Limitação de taxa​

Próximos passos​

Escolha seu caminho de integração​

Integração de uma única empresa​

Plataforma multiempresa​