Skip to main content

Consultando o status de uma importação

Sobre este guia​

Através deste guia, demonstraremos como consultar o status de uma 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. Consultando o status da importação​

    Após gerar um token de acesso válido, faça uma requisição para o endpoint de consulta de importação na nossa API REST (GET/api/v1/file-import/{protocolNumber}), 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}' \
    --header 'accountid: {ACCOUNT}'
    --header 'authorization: Bearer {{ACCESS_TOKEN}}'

    Você receberá o seguinte retorno:

    {
        "protocolNumber": "01HDSC6JPRS8AX8GM5JBQ2XHWE",
        "originalName": "its_a_test.xlsx",
        "createdAt": "2023-10-27T20:11:23.427069Z",
        "importedRegisterCount": 12,
        "status": "FINISHED",
        "FileSizeInBytes": 51212
    }

    Onde:

    • ProtocolNumber: Identificador da importação.
    • OriginalName: Nome do arquivo enviado.
    • CreatedAt: Data da criação da importação.
    • ImportedRegisterCount: Total de registros importados.
    • Status: Status da importação. Onde temos os valores:
      • NEW - Importação criada mas não iniciada.
      • IN_PROGRESS- Importação criada e em processamento.
      • FINISHED - Importação concluída com sucesso.
      • FINISHED_WITH_ERRORS - Importação concluída com erros.
    • FileSizeInBytes - Tamanho do arquivo importado em bytes.