MENU

Introdução

Bem-vindo à documentação de integração do App do Colaborador.

Este documento apresenta os métodos que o cliente deverá fornecer para a realização do setup e integração dos dados.

Premissas

Liberação de acesso

A API ou Webservice fornecido deve permitir acesso através do IP: 104.131.190.97

Protocolo Seguro:

Todos os métodos devem ser acessíveis pelo protocolo HTTPS

Autenticação:

É necessário proteger os métodos com um sistema de autenticação seguro (exemplo: token fixo ou outro método adequado)

Documentação:

Fornecer a documentação da API com acesso, url's, parâmetros (com tipo de dado) e retorno (com tipo de dado).

Métodos

Colaboradores

Método responsável por retornar apenas os dados únicos dos colaboradores, eliminando qualquer duplicidade que possa ocorrer.

`Parâmetros`

Título	Obrigatório	Descrição
Código da matrícula	`não`	Caso preenchido esse parâmetro, deverá retornar somente o fornecedor filtrado
CPF	`não`	Caso preenchido esse parâmetro, deverá retornar somente o fornecedor filtrado

`Retorno`

Chave	Obrigatório
Código da matrícula	`sim`
CPF	`sim`
Nome	`sim`
Celular	`não`
E-mail	`não`

Relatórios / Documentos

`Parâmetros`

Cada relatório pode ter seus próprios parâmetros de entrada, sendo os mais comuns: Período ou Data.

Caso tenha mais de uma unidade, e o número de matrícula possa repetir precisará trazer uma coluna de unidade no relatório.

`Retorno`

O método deverá retornar os dados conforme as informações que a empresa deseja disponibilizar para o produtor e parceiro.

Para documentos (como arquivos para download, por exemplo, holerite), o retorno deve incluir a URL de acesso para que o documento possa ser visualizado ou baixado pelo usuário.

`Arquivos`

Caso deseje disponbilizar arquivos nos relatórios deverá ser passado através de URL, esse endereço deve estar liberado para o IP: 104.131.190.97