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 quatro, 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 coloca um anúncio diante do público, por isso este âmbito pertence a um sistema operado por si, não à configuração de uma página. Apesar do nome, não gere anúncios no sentido da Orbit: isso ativa-se anúncio a anúncio na Orbit.
- Triagem — convida os seus candidatos para triagens com IA em anúncios geridos, e chega a dados de candidatos. Emiti-la é o consentimento da conta às triagens adicionais além das incluídas num anúncio, até ao limite mensal em Orbit → Faturação, por isso pertence a um servidor controlado por si. Veja Fazer a triagem de um candidato.
- Receber candidaturas — envia à Wipperoz as candidaturas e os candidatos que as suas próprias páginas recolheram, e lê o estado de cada candidatura. Traz o consentimento dos candidatos, por isso um Administrador só a pode criar depois de aceitar o Aditamento de tratamento de dados da API, abaixo. Veja Receber candidaturas a partir da sua própria página de carreiras.
- Escolha Criar.
O Aditamento de tratamento de dados da API
Na página de candidatura alojada, a Wipperoz mostra ao candidato o seu texto de consentimento e regista a aceitação. Quando a candidatura acontece na sua página, cabe-lhe a si mostrar esse texto e registar essa aceitação, e o Aditamento de tratamento de dados da API é onde a sua conta assume isso: mostrar o texto sem modificações, enviar um recibo verdadeiro, atestar um fundamento jurídico para cada candidato que envia e manter a chave nos seus servidores.
Um Administrador aceita-o, uma vez, em Orbit → Definições → Chaves de API; a Wipperoz regista a versão, o Administrador e a hora no histórico de consentimentos da conta, ao lado do ATD. Até lá, a Orbit recusa criar uma chave com Receber candidaturas e diz porquê. Uma nova versão do aditamento pede a um Administrador que a aceite antes de criar a próxima chave Receber candidaturas; as chaves existentes continuam a funcionar.
A revelação única
A chave completa é mostrada uma única vez. Copie-a, coloque-a onde vive a configuração do seu sítio web 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 sítio web 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.
