API de Vagas do Procure Aqui

Publica vagas de emprego a partir de outra plataforma e consulta as vagas do Procure Aqui a partir de qualquer sistema externo, usando uma chave de API.

Cada chave de API tem um de três tipos, e só pode usar as operações desse tipo:

Tipo	Pode	Efeito
`interno`	Publicar e apagar	Vaga fica publicada de imediato
`parceiro`	Publicar e apagar	Vaga fica pendente de aprovação
`consulta`	Listar e ler	Só leitura, sem publicar

As chaves são pedidas à equipa do Procure Aqui. Uma chave típica tem este aspeto:

X-API-Key: pa_par_8f3a91c2e6b0d4f7a1c8...

Autenticação

Todos os pedidos exigem o cabeçalho X-API-Key. Sem ele, ou com uma chave inválida ou revogada, a API responde 401 Unauthorized.

curl https://www.procureaqui.net/wp-json/procure-aqui/v1/jobs \
  -H "X-API-Key: pa_con_xxxxxxxxxxxxx"

Nota: a chave viaja no cabeçalho do pedido — usa sempre HTTPS. Guarda-a como farias com uma palavra-passe; se suspeitares que foi exposta, pede a revogação à equipa do Procure Aqui.

POST/jobs

Publicar uma vaga

Cria uma vaga nova. Se enviares external_id e já existir uma vaga com esse identificador publicada pela mesma chave, a vaga é atualizada em vez de duplicada.

Publicado Pendente

Chaves interno → publicado de imediato. Chaves parceiro → pendente até aprovação manual no painel.

Corpo do pedido

Campo	Tipo
`title`	string	obrigatório
`description`	string	obrigatório
`company_name`	string	obrigatório
`company_email`	string (email)	obrigatório
`location`	string	obrigatório
`application`	string	obrigatório — email ou instrução de candidatura
`company_website`	string (url)	opcional
`category_id`	integer	opcional
`job_type_id`	integer	opcional
`external_id`	string	opcional — ativa a atualização em vez de duplicação

curl -X POST https://www.procureaqui.net/wp-json/procure-aqui/v1/jobs \ -H "X-API-Key: pa_par_xxxxxxxxxxxxx" \ -H "Content-Type: application/json" \ -d '{ "title": "Desenvolvedor Backend", "description": "Responsabilidades e requisitos...", "company_name": "Empresa X", "company_email": "rh@empresa.co.ao", "location": "Luanda, Talatona", "application": "rh@empresa.co.ao", "external_id": "vaga-123-plataforma-origem" }'

Resposta — 201 Created

{
"id": 482,
"status": "pending",
"link": "https://www.procureaqui.net/vaga/desenvolvedor-backend/"
}

DELETE/jobs/{id}

Apagar uma vaga

Move a vaga para o lixo. Só funciona se a vaga tiver sido publicada com a mesma chave que está a fazer o pedido — uma chave não pode apagar vagas de outra origem.

curl -X DELETE https://www.procureaqui.net/wp-json/procure-aqui/v1/jobs/482 \ -H "X-API-Key: pa_par_xxxxxxxxxxxxx"

GET/jobs

Listar vagas

Devolve vagas publicadas, com filtros e paginação. Nunca inclui vagas pendentes ou apagadas.

Parâmetros de pesquisa

Parâmetro	Descrição
`search`	Pesquisa livre no título e conteúdo
`location`	Filtra por localização (correspondência parcial)
`category`	Slug da categoria
`job_type`	Slug do tipo de contrato
`page`	Página, a partir de 1 (predefinição: 1)
`per_page`	Resultados por página, até 50 (predefinição: 20)

curl "https://www.procureaqui.net/wp-json/procure-aqui/v1/jobs?location=Luanda&per_page=10" \ -H "X-API-Key: pa_con_xxxxxxxxxxxxx"

Resposta — 200 OK

{
"jobs": [
{
"id": 482,
"title": "Desenvolvedor Backend",
"company_name": "Empresa X",
"location": "Luanda, Talatona",
"category": ["Tecnologia"],
"job_type": ["Full-time"],
"link": "https://www.procureaqui.net/vaga/desenvolvedor-backend/",
"date_published": "2026-07-20T09:12:00+01:00"
}
],
"page": 1,
"per_page": 10,
"total": 34,
"total_pages": 4
}

GET/jobs/{id}

Obter uma vaga específica

Devolve o detalhe completo de uma vaga publicada, incluindo descrição e dados de candidatura.

curl https://www.procureaqui.net/wp-json/procure-aqui/v1/jobs/482 \ -H "X-API-Key: pa_con_xxxxxxxxxxxxx"

Atenção: este endpoint devolve o campo application (contacto de candidatura). Se a plataforma que consome a API for pública, considera se esse dado deve ficar visível ou ser omitido.

Códigos de erro

HTTP	Código	Significado
401	`pa_unauthorized`	Chave em falta, inválida, revogada, ou sem permissão para esta operação
403	`pa_forbidden`	A chave não é dona do recurso (ex: tentar apagar vaga de outra origem)
404	`pa_not_found`	Vaga não encontrada
422	`pa_missing_field` / `pa_invalid_email`	Campo obrigatório em falta ou inválido

{
"code": "pa_missing_field",
"message": "Campo obrigatório em falta: location"
}

Especificação OpenAPI

Para importar a API no Postman, Insomnia ou Swagger, descarrega a especificação completa no formato OpenAPI 3.0.

Descarregar openapi.yaml