A API REST do LocalUp permite que seus desenvolvedores conectem outros sistemas — um CRM, uma ferramenta de BI, seu site — aos seus dados: locais, avaliações e mais. A tela API é onde você cria chaves de API, assina webhooks, acompanha os logs de requisições e abre a referência da API.
Abra-a pela barra lateral: Outros → API. Se você não vê esse item, o acesso à API não está ativado para sua conta — fale com seu gerente de conta. Se a tela disser que você não tem acesso, sua função não permite gerenciar chaves de API.
Início rápido
O bloco Início rápido mostra uma requisição de exemplo. Todos os endpoints ficam em /api/v1 no endereço do seu painel, e toda requisição leva uma chave de API no cabeçalho Authorization:
curl https://<your cabinet address>/api/v1/locations \
-H "Authorization: Bearer <your API key>"
Toda requisição é limitada aos dados da sua conta.
Chaves de API
A tabela Chaves de API lista suas chaves com os Escopos, o Status (active ou revoked) e as datas de Criação e Último uso.
- Criar chave — cria uma chave com um nome e os escopos que ela pode usar. Consulte Criar uma chave de API.
- Rotacionar — emite um novo token para a chave; o token atual deixa de funcionar imediatamente.
- Revogar — desativa a chave; as chamadas feitas com ela passam a falhar imediatamente. Essa ação não pode ser desfeita.
Webhooks
Os webhooks permitem que o LocalUp avise seu sistema quando algo acontece, em vez de seu sistema consultar repetidamente. Clique em Novo webhook, informe um Nome, a URL que deve receber os eventos e os Eventos a assinar e clique em Criar webhook.
A partir daí, o LocalUp envia uma requisição POST assinada para a sua URL sempre que um evento selecionado ocorre. Após a criação, você vê o segredo de assinatura uma única vez — guarde-o e use-o para verificar se as requisições realmente vêm do LocalUp.
Na tabela, você pode usar Enviar teste para colocar um evento de teste na fila, conferir o resultado da Última entrega (OK ou Falhou) e excluir uma assinatura.
Logs de requisições
Logs de requisições · últimos 30 dias lista as chamadas de API feitas com suas chaves: Hora, Método, Caminho, Status, Duração e Chave. Filtre pelo status da resposta para encontrar chamadas com falha; use o botão de atualizar para recarregar a lista.
Referência da API
Clique em Referência da API (no canto superior direito) para abrir a documentação completa dos endpoints disponíveis para suas chaves: URL base, autenticação, limites de requisições, os escopos que cada endpoint exige, parâmetros, esquemas de requisição e resposta e exemplos. Baixar OpenAPI salva a especificação legível por máquina para geradores de código e ferramentas de API.
Cada chave tem um limite de requisições por minuto, compartilhado com o servidor MCP. Quando o limite é excedido, a API responde 429 com o cabeçalho Retry-After. O limite exato aparece na referência da API.