API pública do People Stage System
Para ligar o site da sua empresa, o Zapier, um formulário ou outro sistema ao processo seletivo. As chaves são criadas em Conta → Auditoria e backup → API e integrações (só administradores).
Autenticação
Envie a chave no cabeçalho de toda chamada. Ela começa com ps_live_ e aparece uma única vez, na criação. Limite: 120 chamadas por minuto.
Authorization: Bearer ps_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx Content-Type: application/json
Endereço base: https://app.peoplestage.online/api/publica. Respostas em JSON. Erros vêm como { "erro": "…" } com o código HTTP correspondente (401 chave inválida, 404 não encontrado, 400 dados inválidos).
Endpoints
| Método | Chamada | O que faz |
|---|---|---|
| GET | ?recurso=vagas | Vagas abertas: id, título, empresa, fase, etapas do kanban e link da página pública. |
| GET | ?recurso=vaga&id=12 | Uma vaga com os candidatos. |
| GET | ?recurso=candidatos&vaga=12 | Candidatos de uma vaga (etapa, origem, nota de compatibilidade). |
| POST | ?recurso=candidatos | Cria um candidato na triagem. Corpo: vagaId, nome, email, telefone, cidade, linkedin, pretensao, resumo, curriculoTexto, curriculoPdfBase64 (PDF em base64, até 6 MB; o texto é lido no servidor), origem. Roda as automações da etapa. |
| PATCH | ?recurso=candidato&id=345 | Move de etapa. Corpo: etapa (id de uma etapa da vaga) e, se for reprovar, motivoReprovacao. |
Exemplo: criar um candidato
curl -X POST "https://app.peoplestage.online/api/publica?recurso=candidatos" \
-H "Authorization: Bearer ps_live_…" -H "Content-Type: application/json" \
-d '{"vagaId": 12, "nome": "Ana Lima", "email": "ana@exemplo.com", "telefone": "85999990000", "origem": "site"}'
Resposta 201: { "candidato": { "id": 345, "etapa": "triagem", … }, "automacao": { "feitas": [...], "erros": [...] } }
Webhooks
Ao criar a chave, informe um endereço https://. O sistema faz POST nele a cada evento, com o corpo em JSON e a assinatura HMAC-SHA256 do corpo (segredo mostrado na criação) no cabeçalho X-PeopleStage-Signature: sha256=…. Confira a assinatura antes de confiar no conteúdo.
| Evento | Quando | Dados |
|---|---|---|
candidato.criado | Candidatura pela página da vaga ou pela API | id, vagaId, nome, email, etapa, origem |
candidato.etapa | Candidato mudou de etapa (kanban ou API) | id, vagaId, nome, email, etapa, etapaAnterior, motivoReprovacao |
O envio espera até 5 segundos e não tenta de novo. Responda 200 rápido e processe depois.
Outras portas de entrada
- Página da vaga (
/vaga?v=…) com formulário de candidatura, perguntas eliminatórias e aceite LGPD; traz o JSON-LD que o Google for Jobs lê. - Página de carreiras:
/carreiras(todas as vagas públicas) e/carreiras?e=ID(só as de um cliente, com o logo dele). - Feed XML para agregadores:
/api/vaga-publica?feed=xml. - Calendário: assinatura iCal em Conta → Calendário (Google, Outlook, iPhone).
API e integrações