Criar uma chave de API para a API do Orbit

Este artigo é para administradores da conta que estão conectando um site de carreiras ou outro sistema ao Orbit. Você cria a chave no Orbit e a cola nesse sistema. A documentação para desenvolvedores explica como usá-la.

Abra Configurações

Selecione Configurações na barra lateral.

Abra Chaves de API

Em Conta, selecione Chaves de API.

Comece uma nova chave

Selecione Nova chave.

Dê uma etiqueta à chave

Em Etiqueta, informe onde a chave será usada, por exemplo o endereço da sua página de carreiras. Depois, é por essa etiqueta que você vai saber se é seguro revogar uma chave.

Escolha o que ela pode acessar

Em O que pode alcançar, escolha uma opção:

• Apenas leitura de vagas: suas vagas abertas e os detalhes delas, nada que possa ser alterado.
• Ler e gerir vagas: também cria, edita, publica e encerra vagas. Dê esse acesso só a um sistema que você controla.
• Triagem: os endpoints de triagem de candidatos. Só para um servidor que você controla.

Crie a chave

Selecione Criar chave.

Copie a chave

Selecione Copiar esta chave e guarde-a em um lugar seguro. Esta é a única vez que você vai vê-la.

Confirme que você a guardou

Marque Guardei esta chave num sítio onde a consigo recuperar. e selecione Feito — fechar isto.

Não vejo Chaves de API em Configurações

Só administradores da conta podem criar e revogar chaves de API. Peça a um administrador da sua conta.

O botão de copiar não funcionou

Seu navegador pode ter bloqueado a cópia. Selecione a chave na tela, copie-a manualmente e marque a caixa para confirmar que você a guardou.

Se você perder uma chave

O Orbit armazena só um hash da chave, então ninguém consegue mostrá-la de novo. Substitua-a nesta ordem, para que sua página de carreiras não saia do ar:

1. Crie uma chave substituta.
2. Coloque a nova chave no seu site de carreiras e confira se suas vagas ainda aparecem.
3. Só então revogue a chave antiga.

Duas chaves podem estar ativas ao mesmo tempo, e é isso que permite uma troca sem interrupções.

Revogar uma chave

Em Chaves de API, selecione Revogar ao lado da chave, leia o que vai deixar de funcionar e selecione Revogar agora. Isso vale a partir da próxima requisição e não pode ser desfeito.

Usar a chave

A documentação para desenvolvedores cobre autenticação, endpoints e exemplos. Comece por Criar uma chave de API na documentação para desenvolvedores da Wipperoz, ou selecione Ler a documentação da API na tela de chaves de API.