Manual de criação de URL para API

1 ) Estrutura dos Endereços das Consultas

1.1 ) Domínio

Todas a consultas estão no formato :

https://ABCXYZ/analytics....

Onde o texto "https://ABCXYZ" deve ser substituído pelo endereço do analytics de produção do cliente.

1.2 ) Código Token do Cliente

https://ABCXYZ//analytics/api/Consultas/Executar/TOKEN?...

O texto "TOKEN?" é o Token de identificação do cliente fornecido pela equipe de Arquitetura.

1.3 ) Identificação da Consulta

https://ABCXYZ/analytics.....TOKEN?identificacaoConsulta=folha.Afastamentos

Já o texto "folha.Afastamentos" é o identificador da consulta. Logo, para se utilizar uma consulta diferente das listadas abaixo, basta se alterar o código de identificação da consulta para a consulta desejada.

Obs.: A identificação pode ser encontrada ao se editar a consulta, no campo “Identificação da Consulta”.

1.4 ) Parâmetros da Consulta

https://ABCXYZ/analytics.....identificacaoConsulta=folha.Afastamentos&Parametro01=123& Parametro02=abc&Paramentro03=31/02/2024

O texto "&Parametro01=123& Parametro02=abc&Paramentro03=31/02/2024" são os Parâmetros (Filtros) que uma consulta pode ter.

Segue uma imagem de uma URL completa:

Para entender melhor como organizar a URL, aqui vai um exemplo:

&filtros="NOME DO FILME";"VALOR DO FILTROS"&filtros="NOME DO FILME2";"VALOR DO FILTROS2"

2 ) Consultas

Abaixo estão listadas as consultas e suas respectivas estruturas de retorno.

2.1 ) Afastamentos

2.1.1 ) Endereço :

https://ABCXYZ/analytics/api/Consultas/Executar/TOKEN?identificacaoConsulta=folha.Afast amentos

2.1.2 ) Estrutura de Resposta :

{ "matricula": "02784", "data_inicio": "25/09/2012 00:00:00", "data_fim": "30/12/2099 00:00:00", "codigo": "98", "descricao_sc": "Apos.Invaidez/Doenca", "descricao_cp": "Aposentado Invalidez / Doenca" },

2.2 ) Eventos

2.2.1 ) Endereço :

https://ABCXYZ/analytics/api/Consultas/Executar/TOKEN?identificacaoConsulta=folha.Even tos

2.2.2 ) Estrutura de Resposta :

{ "conta_codigo": "014", "conta_descricao": "Adicional Noturno", "conta_tipo": "PROV", "conta_quantidade": "HORA" },

2.3 ) Cadastro

2.3.1 ) Endereço :

https://ABCXYZ/analytics/api/Consultas/Executar/TOKEN?identificacaoConsulta=folha.Cadastro

2.3.2 ) Estrutura de Resposta :

{ "empresa": "PMM",

"matricula": "01524",

"nome": "MARIA APARECIDA MOTTA",

"data_nascimento": "08/12/1957 00:00:00",

"data_admissao": "02/02/1998 00:00:00",

"ctps_numero": "00000005623",

"ctps_serie": "00042",

"endereco_tipo": "Rua",

"endereco": "SANTA CRUZ",

"bairro": "SANTA CRUZ",

"localidade": "MOGI MIRIM",

"cep": "13800440",

"endereco_numero": "540",

"pis": "12084118109",

"cpf": "171.947.618-74",

"rg": "168013848",

"cargo_codigo": "051",

"cargo_descricao": "COZINHEIRO",

"lotacao_codigo": "3230705020",

"lotacao_descricao": "Demais Profissionais - Creche",

"centro_custo_codigo": "3230705020",

"centro_custo_descricao": "Demais Profissionais - Creche",

"local_trabalho": "121",

"local_trabalho_descricao": "CEMPI FORTUNATA BERTOLAZZO ALBANO", "data_altercao": "20/06/2023 00:00:00" },