API REST

A API REST da PeekHire permite que o teu software trabalhe com os teus dados de recrutamento. É uma API padrão HTTPS + JSON — qualquer linguagem que faça pedidos web pode usá-la.

Explora cada endpoint, parâmetro e esquema na referência OpenAPI interativa:

URL base e versões

A API tem versões. Todos os endpoints ficam sob o prefixo /api/v1, para que as alterações futuras não quebrem a tua integração.

Autenticação

Autentica cada pedido com uma chave de API como bearer token:

curl https://o-teu-host-api/api/v1/campaigns \
  -H "Authorization: Bearer A_TUA_CHAVE_API"

Nunca coloques uma chave de API em código do lado do cliente ou num repositório público.

A que acedes

A API v1 cobre os objetos de recrutamento principais:

• Campaigns — listar e obter as vagas.
• Applications — listar e obter candidaturas.
• Users — listar e obter membros do espaço.

As respostas são JSON e incluem os mesmos campos da app, como o título e o estado de uma campanha ou a fase e o idioma de uma candidatura.

Paginação e filtros

Os endpoints de lista devolvem resultados por páginas. Usa os parâmetros de paginação e os filtros para carregar apenas o necessário.

Erros

A API usa códigos HTTP padrão — 2xx para sucesso, 4xx para problemas no teu pedido (como uma chave em falta), 5xx para erros do servidor. As respostas de erro incluem uma mensagem descritiva.

Relacionado

• Chaves de API
• Webhooks para push em vez de polling