API Tabela de Perfis

Por Henrique Moreira

A partir de um questionamento de um dos nossos clientes, foi desenvolvida pela Systax, uma nova API para consulta dos perfis de cenários que temos nos nossos admins.

A tabela de ids de perfis e suas descrições que divulgamos, muitas das vezes fica desatualizada quando é feito a criação de um novo perfil; agora com essa API, os clientes podem manter atualizados em tempo real, sem a necessidade de intervenção manual.

Essa API consulta as tabelas de perfil origem, destino, natureza de operação e finalidade, facilitando assim a montagem dos cenários e evitando equívocos de criação.

A API, tratando-se de uma API de consulta é método GET, por ser apenas para consulta, e possui os campos:

• Tabela = que deve ser preenchido com 1 (perfil Origem); 2 (perfil Destino); 3 (natureza de operação) ou 4 (finalidade). É possível consultar apenas uma tabela por vez.
• ID = deve ser preenchido com o ID a ser consultado, e pode ser informado em lista (1,2,3...).
• Offset = define a paginação do resultado.
• Limit = limite de itens por página.

Os ids que irão retornar no resultado da API serão apenas os que estão como “Divulgável=S” nas tabelas do admin, e ainda para natureza e finalidade, os que estiverem vigentes, conforme print abaixo:

Outro ponto importante é que temos um serviço no site, na tela de cadastro dos clientes, que deve ser ativo para essa API funcionar:

Abaixo segue exemplo de consulta na API:

Como dito acima, essa API foi desenvolvida a partir de um questionamento de cliente, mas pode ser usada por todos os clientes que contratarem o serviço.

Para demais informações sobre a API, temos o manual disponível:

https://documentacao.systax.com.br/PublicView2/Index/78cc6be7e5ce0290958d3cbc4/71867

API Profile Table

By Henrique Moreira

Based on a request from our client, Systax has developed a new API to query the scenario profiles that we have in our admins.

A lot of time the table that has been published by Systax with the profile ids and their description it is not updated due the creation of a new profile. With this new API, customers can keep it updated in real time without manual intervention.

This API consults the origin, destination, nature of operation and purpose profile tables, to help the creation of scenarios and avoiding any mistake.

This is a query API, which is why we use the GET method and has the following fields:

- Table = which must be filled in with 1 (Source profile); 2 (Destination profile); 3 (nature of operation) or 4 (purpose). Only one table can be consulted at a time.

- ID = must be filled in with the ID to be consulted, and can be entered in a list (1,2,3...).

- Offset = defines the pagination of the result.

- Limit = limit of items per page.

The ids that will be returned in the API response it will only be those that are set to "Disclosable=S" in the admin tables, and for nature and purpose, those that are in force, find below an example:

Another important point, we have a service that needs to be activated on the website in the customer registration part, if we do not perform this step the API it will not work:

Below is an example of an API query:

As mentioned above, this API was developed based on a customer request, but it can be used by all customers who contract the service.

For more information regarding the API,  find below the manual:

https://documentacao.systax.com.br/PublicView2/Index/78cc6be7e5ce0290958d3cbc4/71867

Voltar