Criar uma chave de API
Atualizado
Uma chave de API é o que a sua página de carreiras, ou o seu ATS, apresenta para chegar às suas vagas. É criada na Orbit, é mostrada uma vez e pode ser revogada a qualquer momento. Esta página é o ciclo completo: criar, guardar, rodar, revogar.
Criar a chave
- Na Orbit, abra Definições → Chaves de API.
- Escolha Nova chave.
- Dê-lhe uma etiqueta que diga onde vai viver, por exemplo
página de carreiras — produção. As chaves distinguem-se pela etiqueta e pelos seus últimos quatro caracteres, por isso uma etiqueta escrita a pensar no seu eu futuro vale os dez segundos. - Escolha o âmbito. São três, e o certo é o mais estreito que faça o trabalho: uma chave com mais alcance do que o seu trabalho é uma chave que causa mais estragos quando é exposta.
- Apenas leitura de vagas — as suas vagas abertas e os seus detalhes. O que uma página de carreiras precisa.
- Ler e gerir vagas — também cria, edita, publica e fecha vagas. Publicar gasta créditos, por isso este âmbito pertence a um sistema que você opera, não à configuração de uma página.
- Triagem — os endpoints de triagem de candidatos, que leem dados de candidatos.
- Escolha Criar.
A revelação única
A chave completa é mostrada uma única vez. Copie-a, coloque-a onde vive a configuração do seu site e só depois feche a caixa de diálogo.
Não pode voltar a ser mostrada, e isso não é uma permissão que pudéssemos conceder mais tarde: a Wipperoz guarda um hash da chave, nunca a chave. A lista em Definições mostra a etiqueta, os últimos quatro caracteres, quem a criou e quando foi usada pela última vez. Nunca mostra o valor.
Guardá-la
Trate-a como qualquer outro segredo. A convenção nesta documentação é uma variável de ambiente:
export ORBIT_API_KEY="…a chave que copiou…"Rodar sem interrupções
Nada limita uma conta a uma só chave, e sobrepor chaves é como se faz uma rotação sem a sua página de carreiras ficar às escuras. A ordem importa:
- Crie a chave de substituição.
- Atualize o seu site para a usar e confirme que está a ler as vagas.
- Revogue a chave antiga.
Revogar primeiro e criar depois deixa a sua página de carreiras em baixo durante todo o tempo que a troca demorar.
Revogar
A revogação é imediata e não pode ser desfeita. Um pedido feito com uma chave revogada é recusado logo no pedido seguinte; não há cache nenhuma para esperar. Antes de revogar, veja a última utilização na lista: uma chave usada há minutos é uma chave de que algo depende neste momento, e o movimento seguro é rodá-la como acima em vez de a revogar sem mais.
Uma chave que nunca foi usada costuma significar uma integração começada e abandonada, não uma parada. É a chave mais segura de revogar.
Seguinte
Faça o seu primeiro pedido com a chave na página seguinte.
