Visão geral da API
Três endpoints de processo e duas sondas de saúde.
O Human Plugin é servido em HTTP simples na porta que você configurar (padrão 8080). A URL base é o lugar onde você expõe o container dentro da sua rede, por exemplo http://human-plugin.internal:8080.
| Método | Caminho | Finalidade |
|---|---|---|
POST | /v1/processes | Criar um processo, com um dos fluxos |
GET | /v1/processes/{id} | Consultar um processo |
GET | /v1/processes/{id}/selfie | Consultar a selfie |
GET | /health/live | Verificação de que o serviço está ativo. Veja Saúde e monitoramento |
GET | /health/ready | Prontidão (ping no banco de dados) |
Não há endpoint para listar, excluir ou pesquisar processos, nem receptor de webhook.
Regras que valem para toda chamada
- Sem header de autenticação. O Human Plugin não valida os chamadores. Restrinja o acesso pela rede: veja Rede e segurança.
- Somente JSON, com nomes de campo em camelCase.
- As respostas têm
Cache-Control: no-store. - Os erros usam um único envelope,
{"message": "INVALID_REQUEST", "details": []}. Veja Erros e novas tentativas. idé o id de processo do Human Plugin. Guarde-o a partir da criação: é por ele que você consulta o processo depois.
Sequência típica
Próximo passo: Criar um processo.