Chaves de API

Uma chave de API deixa o seu próprio sistema conversar com o Clakta, quase sempre para enviar pedidos pelo seu servidor. As chaves são da equipe, não de um projeto, e têm permissões próprias, separadas do seu papel. Você só precisa de uma se um desenvolvedor estiver ligando o seu sistema ao Clakta.

Crie uma chave

Vá em Configurações da equipe → Chaves de API e clique em Adicionar chave de API. Só os proprietários da equipe podem criar, editar ou excluir chaves; os membros veem a lista.

Nome

Dê o nome de onde ela roda, como Backend de produção ou Homologação. Se um dia precisar excluir uma às pressas, o nome mostra qual é.

Permissões

Cada área recebe um nível: Nenhum, Leitura ou Escrita. Escrita inclui leitura.

Você pode começar de um de três modelos, Todos, Somente leitura ou Restrito, e ajustar.

Copie na hora

A chave aparece uma única vez, logo depois de criada. Ninguém consegue ver de novo depois, nem o suporte do Clakta. Se você perder, exclua a chave e crie uma nova.

Use a chave

Envie a chave no cabeçalho Authorization, com Bearer antes:

curl https://api.clakta.com/v1/orders \
  -H "Authorization: Bearer $CLAKTA_API_KEY"

await fetch("https://api.clakta.com/v1/orders", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CLAKTA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify(payload),
})

Sem o Bearer , você recebe um erro de "Misconfigured authorization header".

Mantenha as chaves seguras

Acompanhe e exclua chaves

A lista de chaves mostra o Último uso de cada uma, o jeito mais rápido de achar chaves que ninguém usa mais. Configurações da equipe → Logs de API mostra as requisições feitas com as suas chaves, que é onde olhar quando uma integração começa a falhar.

Excluir uma chave vale na hora e não tem volta: o que usa a chave falha na próxima requisição. Ao trocar uma chave, atualize o seu sistema primeiro e exclua a antiga depois.

Limites de requisição

Quantas requisições por minuto você pode fazer depende do plano: 60 no Free, 300 no Starter, 600 no Pro, 1.200 no Business. Veja Planos e limites.