Visão geral

Atualizado 8 de setembro 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 site de um parceiro. A Wipperoz é a ferramenta de produção; a origem é você. 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 site, o que torna as candidaturas da sua página de carreiras separáveis das da Wipperoz nas suas analíticas.
• 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.
• 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 candidaturas pela API. O consentimento que o candidato dá na página de candidatura alojada é o que permite à Wipperoz criar o seu CV Virtual e enviar-lhe um convite para o reclamar. Um formulário construído por si a enviar-nos dados far-nos-ia agir sobre um consentimento que nunca vimos. Ligue para o applyLink; é esse todo o desenho.
• 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 gasta os seus créditos. Nada vai para o ar, nem custa nada, numa chamada que não fez.

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. A página seguinte explica o processo.

URLs base e versionamento

Todos os caminhos começam por /v1. Uma API pública consumida pelos sites 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.