Autenticação

A API Semear LCP aceita um único esquema de autenticação: a API Key, enviada no header X-Api-Key em todas as requisições. A única rota sem autenticação é o health check (GET /healthz).

POST /v5/loan-simulations
X-Api-Key: ukak_{segredo}
Content-Type: application/json

Não há login, token de sessão nem header Authorization: uma requisição sem X-Api-Key válida é recusada com 401 Unauthorized. Para integrar, peça à Semear um usuário de integração e a sua chave.

Collection Postman

A collection Semear LCP - Loan Private Payroll - Docs usa autenticação API Key em todas as requisições. Preencha a variável x_api_key com a sua chave.

A chave

A chave identifica um usuário de integração da sua empresa. Todas as operações herdam desse usuário a empresa, a unidade, o parceiro, a agência e o agente, que definem o que ele enxerga, e o histórico de alterações registra as operações em nome dele.

Formato e guarda da chave

• A chave começa sempre com ukak_, seguido de um segredo aleatório. Envie o valor completo, exatamente como foi entregue.
• A chave completa é exibida uma única vez, no momento em que é gerada. A Semear não guarda a chave em texto claro e não consegue recuperá-la depois: apenas os primeiros caracteres ficam visíveis para identificação. Guarde a chave em um cofre de segredos; se ela for perdida, é preciso gerar uma nova.
• Gerar uma chave nova para o mesmo usuário invalida a anterior imediatamente. Planeje a troca para atualizar a configuração da integração logo em seguida.
• A chave pode ter uma data de expiração. Depois dela, ou se o usuário de integração for bloqueado, desativado ou excluído, as requisições passam a receber 401 Unauthorized.
• A chave não depende de sessão: pode ser usada por vários processos ao mesmo tempo.

Chaves no formato antigo

Chaves emitidas antes da adoção do prefixo ukak_ (inclusive as que começam com api_key_) continuam aceitas, para não interromper integrações em produção. Recomendamos solicitar uma chave no formato novo e substituir a antiga assim que possível.

Permissões e nível de acesso

Cada operação exige uma permissão específica (ex.: "Consultar dados do trabalhador", "Editar empréstimos"), indicada na página de cada endpoint. Além disso, o usuário de integração só enxerga registros do seu nível de acesso (própria unidade, próprio parceiro, própria agência etc.).

Situação	Resposta
X-Api-Key ausente	401 Unauthorized
Chave inválida, expirada ou substituída por uma nova	401 Unauthorized
Usuário de integração bloqueado, desativado ou excluído	401 Unauthorized
Usuário sem a permissão exigida	403 Forbidden (corpo vazio)
Registro existe, mas fora do nível de acesso do usuário	Tratado como não encontrado (400 com o código "não encontrado" do módulo)

Veja Tratamento de erros para o formato completo.