Importando pessoas colaboradoras

Sobre este guia

Através deste guia, demonstraremos como efetuar a importação de pessoas colaboradoras.

Passo a passo

Ambientes

• Ambiente de homologação: https://uat-collaborators-api.acessorh.com.br;
• Ambiente de produção: https://collaborators-api.acessorh.com.br.

1. Obtenha um token OAuth válido

   Caso tenha dúvidas de como obter um token visite a seção sobre autenticação.

2. Baixe a planilha modelo e preencha os dados das pessoas colaboradoras

   Baixe o arquivo modelo de importação. Atente-se que o mesmo é em formato .xlsx. Preencha os dados das pessoas colaboradoras que você deseja adicionar/modificar.

3. Solicitando uma nova importação

   Após gerar um token de acesso válido e preencher a planilha de importação, faça uma requisição para o endpoint de solicitação de importação na nossa API REST (POST/api/v1/file-import), enviando a planilha preenchida anteriormente. Além disso será necessário informar o parâmetro account.

   Parâmetro account

   Este parâmetro deve conter o UUID de qual account dentro da sua organization você deseja importar as pessoas colaboradoras.

   Exemplo de formato de um UUID: 00000000-0000-0000-0000-000000000000

   Abaixo um exemplo da requisição:

   curl --location 'https://collaborators-api.acessorh.com.br/api/v1/file-import?account={ACCOUNT}' \
   --header 'accountid: {ACCOUNT}'
   --header 'authorization: Bearer {{ACCESS_TOKEN}}'
   --form 'file=@"/home/example/Workfolder/unico-people-collaborators/assets/TemplateImportFileWithoutFields.xlsx"'
   

   Você receberá como retorno o número do protocolo para efetuar consulta/obter erros ou quando for acionado via webhook:

   {"protocolNumber":"{IDENTIFICADOR}"}