LocalUpCentral de ajuda
PT
Central de ajuda / Desenvolvedores
Passo a passo

Criar uma chave de API

Crie uma chave de API com os escopos certos, guarde o token com segurança e faça sua primeira requisição à API.

Uma chave de API permite que um programa atue sobre os dados da sua conta pela API do LocalUp ou pelo servidor MCP. Este guia mostra como criar uma chave apenas com o acesso necessário e como mantê-la segura.

Antes de começar:

  • O acesso à API precisa estar ativado para sua conta (o item API aparece na barra lateral), e sua função precisa permitir o gerenciamento de chaves de API.
  • Defina o que a integração precisa fazer — ler avaliações, atualizar locais, conectar um assistente de IA — para escolher os escopos mínimos.

Passos

  1. Abra Outros → API.
  2. Em Chaves de API, clique em Criar chave.
  3. Informe um Nome claro que diga onde a chave é usada, por exemplo Produção · backend.
  4. Marque os Escopos de que a integração precisa. Escolha o mínimo possível. Para conectar um assistente de IA pelo servidor MCP, inclua mcp:connect.
  5. Clique em Criar chave na janela.
  6. A janela Salve seu token mostra o token completo. Esta é a única vez em que ele é exibido. Copie-o e guarde-o em um lugar seguro, como seu gerenciador de senhas ou o armazenamento de segredos do seu servidor.
  7. Clique em Concluído.

Importante: Trate o token como uma senha. Nunca o coloque em código de site que roda no navegador dos visitantes e nunca o compartilhe por e-mail ou chat.

Verifique se funcionou

Faça uma requisição de teste com o token — o bloco Início rápido na tela API mostra um exemplo:

curl https://<your cabinet address>/api/v1/locations \
  -H "Authorization: Bearer <your token>"

Uma resposta bem-sucedida retorna seus locais. Na tela API, a data de Último uso da chave é atualizada e a chamada aparece em Logs de requisições.

Rotacionar ou revogar uma chave

  • Se o token pode ter vazado, ou como boa prática de rotina, use Rotacionar na linha da chave. Um novo token é exibido uma única vez; o antigo deixa de funcionar imediatamente — atualize todas as integrações que o usam.
  • Se a chave não for mais necessária, use Revogar. As chamadas com ela falham imediatamente. Essa ação não pode ser desfeita.

Solução de problemas

  • "O nome da chave é obrigatório" / "Escolha pelo menos um escopo". Preencha o nome e marque pelo menos um escopo.
  • As requisições retornam 401. O token está errado, incompleto, revogado ou foi rotacionado. Confira o cabeçalho Authorization: Bearer ….
  • As requisições retornam 403. Falta à chave um escopo exigido pelo endpoint. A referência da API lista os escopos exigidos por endpoint; crie uma chave com os escopos certos.
  • As requisições retornam 429. Você excedeu o limite por minuto. Aguarde o tempo indicado no cabeçalho Retry-After.
  • Perdi o token. Ele não pode ser exibido novamente. Rotacione a chave para obter um novo token.

Relacionados