ℹ️ Este artigo tem como finalidade auxiliar nas configurações específicas desse provedor, se ainda não leu o artigo de configuração de integração nativa, comece por ele clicando aqui.
Dados necessários:
-
company_id
-
client_secret.
💡 Você consegue obter o Company_id visualizando-a na própria URL da Xerpa conforme o exemplo abaixo:
https://app.xerpa.com.br/company/<O COMPANY ID ESTÁ AQUI>/dashboard
Instruções para envio de dados de acesso: <Clique Aqui>/
-
O primeiro passo para poder utilizar a API da Xerpa é solicitar um token de autenticação. Esta requisição só poderá ser realizada por contas com credenciais de Departamento Pessoal.
-
Os passos para gerar o token são descritos a seguir. No menu principal clique em: Configuração da Empresa > Integrações com outros sistemas > Xerpa API. Digite uma pequena descrição sobre o token e clique no botão Gerar token. Mantenha este token seguro, considere-o como uma senha pois este token permite ao usuário ler, escrever e apagar qualquer informação associada a empresa.
Abaixo segue os campos da Xerpa que a nossa plataforma Qulture.Rocks consegue integrar:
- active
- admissionDate
- birthday
- business_unit
- cpf
- cost_center
- department
- employeeNumber
- gender
- id
- lastDay
- name
- nationality
- office
- position
- position_level
- preferredName
- rg
- salary
- sex
- status
- supervisor_id
Teste da Integração Nativa
Antes de ativar a sincronização de usuários, é altamente recomendado realizar o teste da Integração Nativa. Esse teste permite visualizar previamente quais dados serão replicados na plataforma, evitando alterações indesejadas nos cadastros.
Como realizar o teste:
-
Acesse o menu Organização > Integrações de usuários > Testes.
-
Clique em "Executar teste".
-
Aguarde o carregamento — o processo pode levar alguns minutos.
-
Após a finalização, os usuários identificados aparecerão diretamente na interface.
-
Também será disponibilizado um arquivo em Excel com as informações, facilitando a análise e validação dos dados.
Ficou alguma dúvida? #ChamaNoChat⚠️ Este teste não realiza alterações nos cadastros; ele serve apenas para visualização e conferência prévias.