Autenticação
Crie uma chave de API, defina seus escopos e envie-a como bearer token.
A API do Clakta autentica com uma chave de API, enviada como bearer token em toda requisição. Não há endpoints sem autenticação.
Criar uma chave de API
- Abra Configurações → Chaves de API na sua equipe.
- Clique em Criar chave de API e dê um nome que indique onde ela será usada (por exemplo
shopify-producao). - Selecione os escopos necessários.
- Copie a chave imediatamente — ela é exibida uma única vez e armazenada apenas como hash, portanto não pode ser recuperada depois.
Uma chave de API carrega o acesso da sua equipe. Mantenha-a no servidor, em uma variável de ambiente ou gerenciador de segredos. Nunca a inclua em um bundle de navegador, aplicativo mobile ou repositório público — tudo que chega ao dispositivo do comprador é público.
Autenticar uma requisição
Envie a chave no cabeçalho Authorization, com o prefixo Bearer :
Esquecer o prefixo é o erro mais comum e retorna 400 bad_request — o valor do cabeçalho deve ser Bearer <chave>, não a chave sozinha.
Escopos
Uma chave alcança apenas o que seus escopos permitem, e cada endpoint desta referência informa a permissão que exige. Os escopos seguem o formato <recurso>.<acesso>:
| Escopo | Permite |
|---|---|
orders.read | Ler pedidos |
orders.write | Criar, atualizar e excluir pedidos |
products.read / products.write | Ler / gerenciar produtos |
customers.read / customers.write | Ler / gerenciar clientes |
projects.read / projects.write | Ler / gerenciar projetos |
teams.read / teams.write | Ler / gerenciar equipes |
analytics.read | Ler analytics e eventos |
dashboard.read / dashboard.write | Ler / gerenciar dashboards |
adsManager.read / adsManager.write | Ler / gerenciar contas de anúncio conectadas |
Um escopo write implica o read correspondente. Conceda o conjunto mais restrito possível: uma integração de loja que só registra pedidos precisa apenas de orders.write.
Vale distinguir duas falhas:
401 unauthorized— a chave está ausente, malformada ou revogada.403 forbidden— a chave é válida, mas não tem o escopo exigido pelo endpoint.
Rotação e revogação
As chaves podem ser revogadas a qualquer momento em Configurações → Chaves de API; uma chave revogada para de funcionar imediatamente. Para rotacionar sem indisponibilidade, crie a nova chave primeiro, faça o deploy e só então revogue a antiga.
As requisições feitas com suas chaves são registradas em Configurações → Logs da API, a forma mais rápida de confirmar que uma rotação funcionou ou de descobrir o que uma integração com falha realmente enviou.