Programadores

As tuas chaves de API

Cria as tuas chaves de API para usar o HitCTRL nas tuas ferramentas: Só leitura ou Ler e alterar, e cada alteração leva o nome delas.

Criar uma chave

  1. Abre o teu avatar › Chaves de API e escolhe Nova chave de API.
  2. Dá-lhe o nome do que a vai usar, por exemplo a tua ferramenta de relatórios.
  3. Escolhe Só leitura ou Ler e alterar.
  4. Copia-a agora: a chave só é mostrada uma vez.

O que uma chave pode fazer

Uma chave faz o que podes fazer neste espaço de trabalho e nada mais: a chave de um Owner vê tudo, a de um partner manager vê os seus parceiros, a de um parceiro vê só os seus números. Nunca faz o que só uma pessoa com sessão iniciada pode fazer, como gerir chaves, palavras-passe ou a equipa.

Cada alteração feita com uma chave leva o nome dela no registo de atividade, por exemplo «Chave de API «BI» (criada por Maria)», para saberes sempre o que chegou pela API.

Usá-la

Envia-a em cada chamada para o endereço do teu espaço de trabalho, em x-api-key ou como Authorization: Bearer. As chamadas estão em A referência da API.

Bom saber

  • O plano HitCTRL do teu espaço decide se as chaves funcionam e quantas chamadas por minuto podem fazer. Acima do limite, a resposta é 429 com Retry-After.
  • Revoga uma chave que já não usas: para de imediato e fica na lista, para que as suas alterações mantenham o nome.
  • As chamadas de rastreio do teu servidor usam as chaves próprias do espaço: vê Chaves de API.

Verificado na aplicação a 31 de outubro de 2026