Conecte outros sistemas pela API aberta de RH

A API aberta de RH permite que outro sistema leia pessoas, frequência, afastamentos e folhas finais e envie marcações usando uma chave criada por você. Webhooks de RH avisam o sistema quando algo acontece.

Antes de começar

• Você deve ser o proprietário. Gerentes não podem criar chaves, mesmo com todas as permissões de RH.
• O RH deve estar ativado.

Crie uma chave

1. Abra RH → Configurações de RH e, em Autoatendimento e equipe, selecione API aberta de RH.
2. Marque API aberta ativada e selecione Salvar. A página mostra o Endereço base.
3. Em Criar chave, digite Finalidade (por exemplo, "escritório de folha").
4. Em Pode, marque somente o necessário: ler pessoas, ler frequência, enviar marcações, ler afastamentos, ler folha final, gerenciar webhooks.
5. Selecione Criar chave.
6. Copie a chave agora e entregue ao outro sistema. Ela é mostrada uma vez; o Kluvan mantém apenas um hash.

Adicione um webhook

1. Em Adicionar webhook, digite a URL do sistema (deve começar com https).
2. Marque os eventos: employee.created, employee.left, punch.recorded, leave.approved e payroll.paid. Todos começam marcados.
3. Selecione Adicionar e copie o segredo de assinatura, mostrado uma vez.
4. Confira Entregas para ver o que foi enviado, estado e número de tentativas.

Bom saber

• Chaves separadas. As chaves de RH têm sistema próprio, separado das demais chaves de API do Kluvan, e acessam somente os dados de RH da organização.
• Uma chave nunca lê dados bancários, documentos ou biometria. ler folha final retorna somente folhas pagas, nunca rascunhos, sem IBAN nem número de conta.
• Selecione Revogar para interromper uma chave imediatamente. A lista mostra o último uso e a quantidade de chamadas de cada chave.
• Uma chave pode fazer 10 chamadas por segundo, com picos curtos de até 60. O período solicitado pode ter até 92 dias.
• Uma marcação enviada pela API é adicionada como correção, com o nome da chave como autor. Envie cada marcação uma vez: a mesma enviada duas vezes aparece duas vezes na folha de ponto, e um gerente precisa remover uma.
• Webhooks são assinados com o segredo (HMAC-SHA256 no cabeçalho X-Hr-Signature). Uma entrega com falha é repetida por cerca de um dia; um webhook com 20 falhas consecutivas é desativado até você ativá-lo novamente.
• Ainda não testado contra um endpoint real: a entrega de webhooks foi testada somente em nosso ambiente de testes. Teste com seu sistema antes de depender dela.
• Criação e revogação de chaves e cada marcação enviada são registradas no histórico de atividades.
• Para desenvolvedores, a referência técnica está vinculada na página: Leia como chamar a API.