Modificado em: 16 Aug, 2026
Este guia fornece documentação para a integração com a Jooble REST API. Abaixo, encontrará informações sobre a geração de chaves de API, endpoints, parâmetros de pedido, formatos JSON e códigos de resposta comuns. Se ainda não iniciou a integração, consulte o nosso guia passo a passo sobre Como ligar à Jooble REST API.
Restrições regionais importantes:
Cada domínio da Jooble (país) requer a sua própria chave exclusiva da REST API. Por exemplo, uma chave gerada em jooble.org fornece acesso exclusivo a listagens de vagas nos EUA. Para consultar vagas de outros países, registe-se e obtenha uma chave de API no domínio regional correspondente (por exemplo, uk.jooble.org/api/about para o Reino Unido ou de.jooble.org/api/about para a Alemanha).
Limites de utilização da API:
O plano gratuito da REST API inclui um limite total vitalício de 500 pedidos por chave (trata-se de uma quota vitalícia absoluta, não de um limite mensal).
Como obter uma chave da Jooble REST API
- Registe uma conta no portal de API da Jooble para o país pretendido (por exemplo, pt.jooble.org/api/about).
- Após o registo, copie e guarde de forma segura a sua chave de API gerada.
Parâmetros de pedido (corpo do JSON)
O payload do pedido deve ser enviado no formato application/json com os seguintes parâmetros:
- keywords(string, obrigatório): palavras-chave ou cargos a pesquisar.
- location(string, obrigatório): nome da localização (cidade, região ou país).
- radius(string, opcional): raio de pesquisa em quilómetros. Valores permitidos:
0,4,8,16,26,40,80. - salary(integer, opcional): limite mínimo de salário.
- page(integer, opcional): número de página dos resultados de pesquisa (o valor predefinido é 1).
- ResultOnPage(integer, opcional): número de vagas devolvidas por página.
- SearchMode(integer, opcional): modo do algoritmo de pesquisa (o valor predefinido é 0).
- companysearch(boolean, opcional):
true– pesquisar palavras-chave especificamente em nomes de empresas.false– pesquisar palavras-chave em cargos e descrições.
Parâmetros de resposta
Após um pedido bem-sucedido, o servidor devolve um objeto JSON que contém:
- totalCount(integer): número total de vagas correspondentes encontradas.
- jobs(array): lista de objetos de vagas contendo:
- id(integer): identificador exclusivo do anúncio de emprego.
- title(string): cargo.
- location(string): localização da vaga.
- snippet(string): breve fragmento de descrição apresentado nos resultados de pesquisa.
- salary(string): intervalo salarial formatado como
{min} - {max} {currency}. - source(string): fonte do anúncio de vaga.
- type(string): tipo de emprego (por exemplo, Full-time, Part-time).
- link(string): ligação direta para o anúncio de vaga no Jooble.
- company(string): nome da empresa.
- updated(string): carimbo de data/hora ISO da última atualização da vaga.
Exemplos de pedido e resposta JSON
Exemplo de payload de pedido:
Exemplo de resposta de sucesso (200 OK):
Códigos de erro e resposta HTTP
- 200 OK: o pedido foi bem-sucedido e devolveu dados.
- 403 Access Denied: chave de API inválida ou em falta.
- 404 Not Found: o endpoint ou recurso solicitado não existe.
Exemplos de implementação de código
Pode integrar a Jooble REST API utilizando linguagens de programação como PHP, JavaScript, Python (2.7 / 3.5+), C# (.NET 4+), Ruby, entre outras. Estão disponíveis fragmentos de código prontos a utilizar e guias de implementação na nossa Página de Documentação da Jooble API.