Ambientes
As URLs públicas de sandbox e produção são fornecidas pela equipe da Semear e não fazem parte deste repositório. Todos os exemplos usam o placeholder:
https://{base-url}
O valor padrão da variável baseUrl na collection (https://localhost:2026) aponta para um ambiente local e deve ser substituído.
Prefixo de rota
Todas as rotas documentadas usam o prefixo de versão v5:
https://{base-url}/v5/<recurso>
Rotas v4 de compatibilidade
A API mantém algumas rotas com prefixo v4 — simulação (POST /v4/loan-simulations), emissão (POST /v4/loans), consulta e desembolso de empréstimos (PUT /v4/loans/{id}/disbursements) — apenas para integrações anteriores à v5 que ainda não migraram. A simulação v4 devolve o formato antigo, com campos já retirados da v5 (como cet, monthlyCet, annualCet, debitAmount e disbursementScenarios); as rotas v4 de empréstimo devolvem o contrato com a hierarquia organizacional e o log de auditoria. Nenhuma delas faz parte do contrato desta documentação. Integrações novas devem usar somente v5.
Health check
GET https://{base-url}/healthz informa se a API está no ar. Não exige autenticação nem headers e responde 200 OK com o texto Healthy quando a aplicação está saudável (503 com Unhealthy, caso contrário). Use em monitoramento e balanceadores; não serve para validar a API Key.
Collection Postman
A collection Semear LCP - Loan Private Payroll - Docs acompanha esta documentação: suas requisições são as etapas do passo a passo, na mesma ordem. Todas usam autenticação API Key (header X-Api-Key) e os scripts de teste preenchem as variáveis de saída.
| Variável | Preenchida por | Uso |
|---|---|---|
baseUrl | você | Origem do servidor. O padrão (https://localhost:2026) aponta para um ambiente local e deve ser substituído. |
x_api_key | você | Chave de integração, enviada em X-Api-Key em todas as requisições. |
workerCpf, workerName | você (padrão: trabalhador de referência da homologação) | CPF e nome do trabalhador usados no termo, no aceite e no tomador da emissão. |
termId, termKey | Criar Termo de Autorização | id e key do termo criado. |
signatureId | Assinar Termo | id do envelope de assinatura do aceite. |
relationshipQueryId, relationshipQueryCode | Consultar vínculos com um termo já criado | id e code da consulta de vínculos. |
employmentRelationshipId | Consultar vínculos por ID da Consulta | id do primeiro vínculo elegível e não bloqueado (ou do primeiro, se nenhum for). |
employeeDataId, employeeDataCode | Consulta dados do trabalhador | Consulta usada no bloco privatePayroll da emissão. |
fgtsBalanceId, fgtsBalanceCode | Consulta de garantias FGTS | Consulta usada na emissão com garantia. |
today, disbursementDate, firstDueDate | script de pré-requisição das emissões | Hoje, hoje e um mês depois, no formato AAAA-MM-DD. |
loanId, signatureDate, endorsementDate, disbursementDate | qualquer uma das quatro emissões | Contrato emitido e datas usadas na assinatura, na averbação e no desembolso. |
disbursementKey | Consultar Desembolso por ID da Operação | key do comando de desembolso mais recente. |
Todos os scripts gravam nas variáveis da collection. Se você tiver um ambiente com variáveis de mesmo nome, apague-as: o valor do ambiente tem prioridade sobre o da collection e esconderia os identificadores gravados pelos scripts.
Alguns exemplos de resposta salvos na collection são anteriores à versão atual da API (por exemplo, o termo com type = data_inquiry e valores com duas casas decimais). Os formatos válidos estão nas páginas de referência.