API de Processo Seletivo

A API leva o processo seletivo para o seu site e para os seus sistemas. Ela faz tudo o que a página de inscrição da Workfuse faz, e a inscrição chega à secretaria como qualquer outra.

O que você consegue fazer

Tarefa	Guia
Montar a sua página de inscrição: catálogo de cursos, edital, formulário e envio, nos mesmos passos da página da Workfuse	Montar a página de inscrição
Consultar a situação de um inscrito pelo número da inscrição, pelo CPF ou pelo e-mail, e mostrar a ele em que etapa está	Consultar a situação
Integrar o portal de prova: o candidato chega ao portal com o número da inscrição, o portal confere se ele pode fazer a prova e envia a nota de cada tentativa	Portal de prova

Os endpoints

Todos ficam em API_BASE/public/v1/admissions. O detalhe de cada um (parâmetros, resposta e erros) está na Referência.

Para montar a página de inscrição

Endpoint	O que faz
GET /institution	nome, logo e cor da instituição
GET /courses	o catálogo de cursos
GET /courses/{courseId}	um curso, com o edital aberto de cada modalidade
GET /curriculums/{curriculumId}	a matriz curricular, período a período
GET /links/{slug}	para onde aponta um link de campanha (?origem=)
GET /notices/{noticeId}/showcase	o que o edital oferece: cursos por polo, formas de ingresso e taxa
GET /notices/{noticeId}/application-fields	os campos do formulário de uma forma de ingresso
GET /postal-codes/{cep}	o endereço de um CEP
POST /applications/draft	grava a inscrição como rascunho
POST /applications	conclui a inscrição

Para consultar a situação

Endpoint	O que faz
GET /applications/{id}	uma inscrição inteira, com as etapas e o histórico
GET /applications?candidateCpf=	as inscrições de uma pessoa pelo CPF
GET /applications?candidateEmail=	as inscrições de uma pessoa pelo e-mail

Para o portal de prova

Endpoint	O que faz
GET /applications/{id}	se a inscrição que chegou pelo link pode fazer a prova agora
POST /applications/{id}/exam-attempts	a nota de uma tentativa
GET /exam-candidates	a lista de quem pode fazer a prova, para preparar o portal

Como chamar

Endereço	API_BASE/public/v1/admissions. Em produção, API_BASE é https://api.workfuse.com
Credencial	a API key da instituição no header Authorization: Bearer wf_..., com o módulo Captação & Processo seletivo · Processo seletivo marcado. Como gerar: Autenticação
Instituição	é a da chave. Nenhum endpoint recebe organização ou instituição
Formato	JSON na requisição e na resposta
De onde chamar	do seu servidor, nunca do navegador. A chave lê a ficha completa de qualquer candidato da instituição, CPF incluído; a sua página chama o seu back-end, e ele chama a Workfuse
Testar no navegador	o Swagger, com try-it-out

Os nomes da API

A API usa os nomes do painel, em inglês. Os que mais confundem na primeira leitura:

No painel	Na API	O que é
Edital	/notices · admissionNoticeId	a captação: datas, taxa, cursos e formas de ingresso abertas
Oferta	offers[] na vitrine · admissionOfferId	um curso num polo, dentro do edital. A inscrição escolhe a oferta, não o curso
Forma de ingresso	journeys[] na vitrine · admissionNoticeEntryFormId	vestibular, nota do ENEM, transferência… como está ativa naquele edital. Ela decide se há prova e se há taxa
Inscrição	/applications	o que você cria. Uma por pessoa (CPF) em cada edital
Etapas	journey[] na inscrição	o caminho da inscrição: cadastro, documentos, avaliação, pagamento, convocação e matrícula

O que a API ainda não faz

Não faz	O que existe hoje
pagar a taxa	a inscrição nasce cobrada ou isenta, e a secretaria confirma o pagamento
receber arquivo de documento	a API lista os documentos que a matrícula vai pedir; o envio do arquivo não está aberto
editar uma inscrição concluída	a correção passa pela secretaria
avisar mudança por webhook	releia a inscrição e compare o updatedAt: Acompanhar mudanças
receber nota de outras formas de ingresso	só o vestibular com prova recebe nota pela API; a nota do ENEM vai no próprio envio. Detalhe