API de Integraçãov1.1

Conteúdo

Introdução
Autenticação dos Serviços
Paginação e Total de Registros
Filtrando recursos modificados após determinada data
Ambiente de Testes
Recursos
Documentação dos recursos no Postman

Introdução à API

A Wonder Sistemas disponibiliza uma API REST, com dados no formato JSON, para fins de integração com outros softwares.

Como os serviços estão disponíveis a partir do servidor de cada cliente, os seguintes dados de acesso devem ser obtidos com o administrador do sistema:

- URL do servidor (http ou https, IP e porta)
- Usuário
- Senha

Com isso, é possivel montar a url base para execução dos serviços, no formato:

https://<IP_DO_SERVIDOR>:<PORTA_DO_SERVIDOR>/probusweb/seam/resource/probusrest/<recurso>

A API suporta acesso via http ou https, conforme configuração de cada cliente. Por razões de segurança, recomendamos sempre a utilização de https. Nos exemplos abaixo a url será representada por ${URL_BASE}, substitua de acordo cfe. o servidor que estiver utilizando.

É necessário estar logado no servidor para ter acesso à definição de serviços. Por favor, obtenha os dados de acesso com o administrador do sistema ou utilize o nosso servidor de teste.

Autenticação dos Serviços

A execução dos serviços requer autenticação via token(API Key), através do header Authorization. A obtenção do token se dá através do endpoint de login.

Parâmetros

Parâmetro	Descrição
usuario	Usuário de acesso fornecido pelo administrador
password	Senha do usuário fornecido pelo administrador

POST /api/v1/session

Exemplo

curl --request POST \
     --url ${URL_BASE}/api/v1/session \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --insecure \
     --data '{
	     "usuario": "integracao",
	     "password": "integracao"
     }'

HTTP/1.1 200 OK  

{
  "codigo": "INTEGRACAO",
  "nome": "Integracao",
  "token": "fbf72edf9bc54c3a96793bd147a7645d"
}

Utilizando o token

Substitua ${TOKEN} pelo conteúdo da chave token retornada da autorização

curl --request GET \
     --url ${URL_BASE}/api/grupos/ \
     --header 'Accept: application/json' \
     --header 'Authorization: ${TOKEN}' \
     --insecure

Paginação e Total de Registros

Os serviços de listagem de dados podem retornar grandes quantidades de registros, por isso definimos os parâmetros para paginação de dados.

São eles:

page: determina a página atual de dados.
perPage: determina a quantidade de registros a serem retornados por página (default 100).

Além disso, os serviços retornam os headers:

x-total-count: total de registros da consulta
x-page: página atual
x-per-page: quantidade de registros por página
x-total-page: total de páginas

Exemplo:

curl --request GET \
     --url ${URL_BASE}/api/grupos \
     --header 'Accept: application/json' \
     --header 'Authorization: ${TOKEN}' \
     --insecure
     --include

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
X-Powered-By: Servlet 2.5; JBoss-5.0/JBossWeb-2.1
x-page: 1
x-per-page: 100
x-total-count: 23
x-total-page: 1
Content-Type: application/json

Filtrando recursos modificados após determinada data

Alguns dos serviços aceitam o parâmetro modificadosApos, o qual representa uma data no formato ISO 8601 ('YYYY-MM-DD"T"HH:MI:SS TZH:TZM' - Ex: "2022-01-01T12:00:00-03:00"), e retornam todos os registros com data/hora de alteração posterior ao valor do parâmetro. Verifique na documentação de cada serviço se o parâmetro está disponível.

Ambiente de Testes

Disponibilizamos um servidor para testes e validação dos serviços.

http://www.wonder.com.br:9999
usuário: integracao
senha: integracao

Essa URL e credenciais são para uso exclusivo no ambiente de testes.

Para acesso ao servidor de produção de cada cliente, solicite os dados de acesso ao administrador do sistema.

Recursos

Para mais detalhes favor verificar a Documentação dos recursos no Postman