Logótipo da PeekHire
Automação e programadores

Chaves de API

Criar, limitar e rodar as chaves que autenticam o acesso à API.

As chaves de API autenticam o acesso programático à PeekHire — tanto a API REST como as tuas automações no-code.

Criar uma chave

  1. Vai a Ferramentas para programadores → Chaves de API → Criar.
  2. Dá um nome descritivo (p. ex. Integração do Zapier).
  3. Copia o valor da chave ao ser mostrado — por segurança, não poderás vê-lo depois.

Usar uma chave

Envia a chave como bearer token em cada pedido:

curl https://o-teu-host-api/api/v1/applications \
  -H "Authorization: Bearer A_TUA_CHAVE_API"

Permissões

Cada chave tem permissões que limitam o que pode fazer:

  • Leitura — obter dados (listar e obter campanhas, candidaturas, utilizadores).
  • Escrita — criar ou modificar dados.

Concede apenas o que a integração precisa (menor privilégio). Uma chave só de leitura chega para sincronizar dados para uma folha de cálculo ou um painel; adiciona Escrita apenas quando a integração tiver de alterar algo na PeekHire.

Manter as chaves seguras

  • Trata as chaves como palavras-passe. Quem tem uma chave pode agir.
  • Nunca faças commit de chaves num repositório ou código de cliente.
  • Uma chave por integração, para poder revogar uma sem afetar as outras.
  • Guarda as chaves num gestor de segredos, não em texto simples.

Rodar e revogar

Se uma chave for exposta — ou por rotina — cria uma nova, atualiza a tua integração e elimina a antiga. Eliminar uma chave revoga o acesso de imediato.