OlaClick Public API

API REST versionada para parceiros externos da OlaClick. Use-a para ler seu menu, gerenciar produtos e ler pedidos de forma programática.

Todas as respostas são JSON. Todas as requisições devem ser feitas via HTTPS.

URL Base

Ambiente	URL Base
Produção	https://public-api.olaclick.app

A versão atual da API é v0. Os endpoints de negócio são servidos sob o prefixo de path /v1 (ex.: GET /v1/orders).

Autenticação

Toda requisição deve ser autenticada. Há duas opções.

1. API key (mais simples)

Envie sua chave (ela começa com olk_) em toda requisição, usando um destes headers:

# Opção A — X-API-Key
curl https://public-api.olaclick.app/v1/menu \
  -H "X-API-Key: olk_your_key_here"

# Opção B — Authorization: Bearer
curl https://public-api.olaclick.app/v1/menu \
  -H "Authorization: Bearer olk_your_key_here"

As API keys são emitidas por empresa. Se você ainda não tem uma, solicite-a ao seu contato OlaClick. As chaves são gerenciadas em /auth/api-keys (criar, listar, atualizar, revogar) — veja a seção API Keys na referência.

Trate sua API key como uma senha: nunca a envie para o controle de versão nem a exponha em código client-side. Se uma chave for exposta, revogue-a imediatamente.

Scopes

Os access tokens OAuth são restritos aos scopes solicitados. Os scopes disponíveis são:

Scope	Concede acesso a
menu:read	Ler menu, categorias e produtos
menu:write	Criar/atualizar produtos
orders:read	Listar e 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

As API keys recebem scopes no momento em que são criadas.

Limitação de taxa

As requisições são limitadas por credencial. Se você exceder o limite, receberá 429 Too Many Requests — reduza o ritmo e tente novamente após um breve intervalo. Construa clientes que lidem com respostas 429 de forma adequada, em vez de assumir uma cota fixa.

Erros

A API usa códigos de status HTTP padrão:

Código	Significado
200 / 201	Sucesso
400	Requisição inválida (parâmetros ou corpo incorretos)
401	Credenciais ausentes ou inválidas
403	Autenticado, mas sem o scope necessário
404	Recurso não encontrado
429	Limite de taxa excedido
5xx	Erro do servidor — seguro repetir requisições idempotentes