Skip to main content

Baixando arquivo de erros de importação

Sobre este guia​

Através deste guia, demonstraremos como baixar um arquivo de erros de importação. Esse cenário ocorrerá quando na importação o status voltar como FINISHED_WITH_ERRORS.

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. Baixando o arquivo de erros de importação​

    Após gerar um token de acesso válido, faça uma requisição para o endpoint de download do arquivo de erros na nossa API REST (GETapi/v1/file-import/{PROTOCOL_NUMBER}/error-file-url), enviando o protocolNumber e account.

    Parâmetro account

    Este parâmetro deve conter o UUID de qual account dentro da sua organization você deseja efetuar essa operação.

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

    Parâmetro protocolNumber

    Este parâmetro deve conter o identificador obtido ao solicitar uma importação de pessoas colaboradoras.

    Abaixo um exemplo da requisição:

    curl --location 'https://collaborators-api.acessorh.com.br/api/v1/file-import/{PROTOCOL_NUMBER}/error-file-url' \
    --header 'accountid: {ACCOUNT}'
    --header 'authorization: Bearer {ACCESS_TOKEN}'

    Após efetuar a requisição o arquivo será baixado e você poderá armazenar o mesmo para consulta.