Este tutorial tem como objetivo instruir o leitor a entender o que é a jornada do colaborador, quais são as APIs existentes, como criar a chamada da API, autenticar e como aplicar filtros e paginação na requisição.

O que é a jornada do colaborador?

A jornada do colaborador pode ser definida como o conjunto de todas as experiências que um colaborador tem em relação a sua organização. Dentro desse conjunto se encontram o recrutamento e seleção, admissão do colaborador, o desenvolvimento e por fim o desligamento. Temos como objetivo das APIs da jornada disponibilizar informações referentes aos colaboradores nas diferentes etapas dele na organização, como por exemplo permitir que sejam obtidos os dados cadastrais de uma pessoa após realizar a admissão dela.

Como funcionam as APIs?

Todas as APIs disponibilizadas foram implementadas no formato de serviço REST, deste modo qualquer ferramenta que possa fazer chamadas HTTP pode consumir os endpoints da jornada do colaborador.

As APIs desenvolvidas possuem suporte às funcionalidades padrão das entidades da plataforma, como filtros, paginação e ordenação. Você pode ler mais sobre essas funcionalidades nos links abaixo. Não se preocupe, durante o tutorial nós faremos alguns exemplos de filtros que podem ser utilizados.

Para poder utilizar as nossas APIs é necessário informar um token que vai indicar que o consumidor está autorizado a utilizar as APIs. Esse token pode ser obtido de diferentes modos através das APIs do Authentication.

O que pode ser feito com as APIs?

As APIs da jornada do colaborador permitem que sejam obtidos os dados dos colaboradores nas diferentes etapas da sua jornada. Ou seja, é possível obter os dados contratuais dos colaboradores admitidos e demitidos, dados pessoais e cadastrais. Desse modo é possível realizar integrações e sincronias a partir das informações salvas na base de dados do HCM.