Visão geral

Atualizado 13 de outubro de 2026

A API da Orbit permite que uma conta leia as suas próprias vagas e as coloque onde quiser: uma página de carreiras no seu próprio domínio, uma intranet, o sítio web de um parceiro. A Wipperoz é a ferramenta de produção; a origem é a sua organização. O seu domínio fica com o valor de pesquisa, a sua marca fica com o candidato, e nós não nos colocamos entre si e a sua contratação.

O que faz

• Lê as suas vagas. GET /v1/jobs devolve as vagas que a sua conta publicou, assinalando as fechadas e as expiradas, para que uma página construída por si mostre o seu próprio estado de fecho em vez de partir ligações que já publicou.
• Entrega os candidatos à página de candidatura alojada. Cada vaga traz um applyLink. Envie os candidatos para lá. A página de candidatura regista que vieram do seu sítio web, o que torna as candidaturas da sua página de carreiras separáveis das da Wipperoz nas suas analíticas.
• Recebe candidaturas a partir da sua própria página. POST /v1/jobs/{jobId}/applications envia uma candidatura que a sua página de carreiras recolheu, com o recibo de consentimento que o seu servidor registou, e a Wipperoz constrói o CV Virtual do candidato e escreve-lhe para que o reclame, como se se tivesse candidatado na página alojada. POST /v1/candidates adiciona uma pessoa a Meus candidatos a partir do seu sistema. Ambos precisam do âmbito Receber candidaturas, que um Administrador só pode criar depois de aceitar o Aditamento de tratamento de dados da API.
• Recebe as suas vagas. POST /v1/jobs cria uma vaga a partir do seu próprio sistema — um ATS, uma ferramenta interna — como rascunho, e POST /v1/jobs/{jobId}/publish põe-na no ar. Editar e fechar também existem, para que uma vaga que muda na origem possa mudar aqui.
• Faz a triagem de candidatos. POST /v1/jobs/{jobId}/candidates/{candidateId}/screening convida um candidato de um anúncio gerido para uma triagem com IA, com uma chave própria.
• Continua a ser sua. Cada resposta está limitada à conta cuja chave fez o pedido. Não há leitura nem escrita entre contas, nem um endpoint de “todas as vagas”.

O que não faz

• Receber uma candidatura sem o consentimento do candidato. O consentimento que o candidato dá é o que permite à Wipperoz criar o seu CV Virtual e enviar-lhe um convite para o reclamar. Na página de candidatura alojada, a Wipperoz mostra o seu texto de consentimento e regista a aceitação; na sua página, o seu servidor mostra o mesmo texto, sem modificações, e envia-nos o recibo, ao abrigo do Aditamento de tratamento de dados da API que a sua conta aceitou. Uma candidatura sem esse recibo responde 422.
• Guardar as suas credenciais de portais de emprego nem publicar neles por si. A distribuição para portais é um feed para o qual aponta um portal, não credenciais que nos entrega.
• Publicar sem lhe ser pedido. Criar uma vaga e publicá-la são duas chamadas, porque publicar coloca um anúncio diante do público. Nada vai para o ar numa chamada que não fez.
• Gerir os seus anúncios. Publicar é grátis. Gerir um anúncio — ordenar os candidatos, comparar o seu pool com o anúncio, fazer a triagem — é o serviço pago da Orbit, e um recrutador ativa-o na Orbit. Nota-se aqui em dois sítios: o título e a categoria de um anúncio gerido não podem ser mudados pela API, e só um anúncio gerido pode fazer triagens.

A quem se destina

• Alguém de recrutamento ou de engenharia a ligar uma página de carreiras às vagas que uma conta publica na Orbit.
• Uma agência a avaliar se a Orbit encaixa num fluxo de trabalho existente com ATS ou MCP.

O que precisa

1. Uma conta Orbit com pelo menos uma vaga publicada.
2. Uma chave de API criada em Orbit → Definições → Chaves de API, com o âmbito que corresponde ao trabalho: leitura de vagas para uma página de carreiras, ler e gerir vagas para também publicar vagas, triagem para convidar candidatos para triagens, Receber candidaturas para receber candidaturas na sua própria página. A página seguinte explica o processo.

URLs base e versionamento

Todos os caminhos começam por /v1. Uma API pública consumida pelos sítios web de outras pessoas não pode mudar no lugar, por isso uma alteração incompatível chegará como /v2, com a /v1 a continuar a responder.