Configurar uma fonte de dados REST
 |
 |
Pré-requisito
- Acesso ao menu Configuração > Fonte de dados REST (AD052).
Apresentação
O sistema permite configurar fontes de dados, visando possibilitar a conexão do SoftExpert Suite com outros sistemas via Web Service REST.
Veja como configurar uma fonte de dados REST dentro do sistema:
Configurar fonte de dados REST
A fonte de dados REST pode ser configurada também para utilizar as APIs do SoftExpert Suite. Para cada interface REST disponibilizada pelo SoftExpert Suite, é necessário configurar uma fonte de dados REST. Por exemplo: para utilizar a interface RIS_RISK_INTERFACE, é necessário criar uma fonte de dados REST que será utilizada para realizar a conexão e terá os parâmetros necessários para esta interface. Se, além desta interface, a interface RIS_CONTROL_INTERFACE também for utilizada, será necessário criar outra fonte de dados.
Confira informações extras sobre cada uma das etapas do cadastro da fonte de dados REST:
Dados do serviço REST
Dados do serviço
• O Identificador deve conter letras e pode conter números, porém não pode iniciar com números.
• No campo URL do serviço, devemos informar a URL do API REST que será utilizada para realizar a integração. Se o serviço for utilizar parâmetros do tipo PATH, estes devem ser informados na própria URL (basta adicionar um endpoint, como: https://exampleservice.com/user/{path}). Note que o parâmetro PATH que for informado na URL será adicionado pelo sistema na etapa Parâmetro de entrada, sendo que este deve ter um valor durante o consumo para que a operação seja realizada com sucesso.
• Se habilitarmos a opção Web Service interno do SoftExpert Suite, será possível selecionar uma API REST interna disponibilizada pelo SoftExpert Suite. Com isso, não será necessário criar uma fonte, caso as configurações de domínio do ambiente sejam alteradas.
• Ao configurar uma interface REST disponibilizada pelo SoftExpert Suite, é possível obter a URL do serviço na seção Reference.
Parâmetros de entrada
Métodos HTTP disponíveis para seleção:
| GET | Realiza a operação de recuperação de dados do serviço adicionado. |
| POST | Realiza a operação de envio de dados do serviço adicionado. |
| PUT | Realiza a operação de atualização de dados do serviço adicionado. |
| DELETE | Realiza a operação de remoção de dados do serviço adicionado. |
Tipos de parâmetro disponíveis para seleção:
| QUERY | Indica que o parâmetro será uma Query string. |
| HEADER | Indica que o parâmetro será um Header necessário para a requisição. |
| PATH | Esta opção não estará disponível para seleção. Ela será apresentada, já selecionada, quando o parâmetro listado for um endpoint na URL de serviço informada na etapa anterior. |
Tipos de dados disponíveis para seleção:
| STRING | O valor do parâmetro será do tipo texto. |
| NUMERIC | O valor do parâmetro será do tipo numérico. |
| DECIMAL | O valor do parâmetro será do tipo numérico com casas decimais. |
| BOOLEAN | O valor do parâmetro será do tipo lógico: true or false. |
| DATE | O valor do parâmetro será do tipo data. Ao selecionar esta opção, será apresentado o campo Máscara de data. Nele, selecione o formato de data no qual se deverá informar o valor do parâmetro. Veja, a seguir, exemplos de uso. |
Se o método selecionado anteriormente for POST ou PUT, será apresentado o campo Corpo da requisição, no qual deverá ser adicionado um exemplo para o corpo da requisição no formato JSON. O corpo de exemplo será utilizado pelo SoftExpert Suite para mapear os atributos que serão enviados pela requisição.
Veja um exemplo de corpo da requisição que poderá ser informado no campo apresentado:
{
"id": 1,
"name": "New example name"
}
É possível, também, enviar exemplos com tipo de data:
{
"id": 10,
"name": "example",
"admission Date": "MM/dd/yyyy"
}
O parâmetro de data deve estar utilizando o valor de formatação corretamente. Veja a seguir alguns exemplos de formatos de datas:
| Formatação | Descrição | Exemplo |
| MM/dd/yyyy | Padrão americano de data | 06/22/2024 |
| dd/MM/yyyy | Padrão europeu de data | 15/03/2024 |
| HH:mm:ss | Horas, minutos e segundos | 18:37:05 |
| KK:mm:ss a | Horas, minutos e segundos (AM/PM) | 07:44:23 PM |
| dd/MM/yyyy HH:mm:ss | Data, horas, minutos e segundos | 26/12/2024 12:30:55 |
| dd/MM/yyyy KK:mm:ss a | Data, horas, minutos e segundos (AM/PM) | 12/07/2024 11:50:02 AM |
| EE MMM dd hh:mm:ss Z yyyy | Data descritiva, dia, horário (AM/PM), fuso horário e ano | Ter ago 16 12:00:00 BRT 2024 |
• Ao configurar uma interface REST disponibilizada pelo SoftExpert Suite, deve-se selecionar o método POST. Pode-se obter o corpo da requisição na seção Reference.
Parâmetros de saída
• Os exemplos a serem informados no Corpo da resposta se assemelham aos explicados para o Corpo da requisição da etapa Parâmetros de entrada.
• Ao informar o corpo da requisição/resposta nas seções Parâmetros de entrada e Parâmetros de saída, podem ocorrer problemas que impossibilitam seu avanço para a próxima etapa. Consulte a seção Troubleshooting para ver os possíveis problemas e suas soluções.
• Ao configurar uma interface REST disponibilizada pelo SoftExpert Suite, pode-se obter o corpo da resposta no documento Guia de integração.
Segurança
Na etapa Segurança, é possível definir uma lista de segurança para a fonte de dados REST, restringindo o acesso somente a quem for necessário.
Confira as opções disponíveis na aba:
Privado
Apenas os usuários definidos nesta aba poderão editar ou visualizar a fonte de dados REST. Para isso, utilize as seguintes colunas:
- Editar: defina os usuários, equipes, áreas e/ou funções que terão permissão para editar a fonte de dados.
- Visualizar: defina os usuários, equipes, áreas e/ou funções que terão permissão para visualizar a fonte de dados.
Público
Todos os usuários do sistema poderão visualizar a fonte de dados REST, porém apenas os usuários definidos na respectiva coluna poderão editá-la. Por isso, a coluna Visualizar estará desabilitada (visto que a fonte de dados poderá ser visualizada por qualquer usuário).
Na coluna Editar, defina os usuários, equipes, áreas e/ou funções que terão permissão para alterar os dados da fonte de dados.
Resumo
Após clicar no botão Teste de consumo, na tela que será aberta, devem ser preenchidas as informações conforme as especificações do serviço que está sendo consumido.
Entre os parâmetros disponíveis no teste de consumo, podem ser preenchidas as seguintes informações:
| Caminho (Path) | Parâmetros do tipo PATH definidos na URL do serviço. |
| Consulta (Query) | Parâmetros do tipo QUERY definidos na etapa Parâmetros de entrada. |
| Cabeçalho (Header) | Parâmetros do tipo HEADER definidos na etapa Parâmetros de entrada. |
| Corpo de requisição (Request body) | Parâmetros do corpo de requisição utilizado para consumir os serviços. |
Para consumir o serviço, clique no botão Executar, da parte inferior da tela. Podem ser apresentados dois tipos de resposta:
- Sucesso: o consumo foi realizado com sucesso. Neste caso, será possível visualizar um JSON contendo o retorno do serviço via SoftExpert Suite.
- Algo deu errado: ocorreu um problema ao consumir o serviço. Consulte a seção Troubleshooting para ver as possíveis respostas e seus significados.
Conclusão
Pronto! Agora você já sabe como configurar uma fonte de dados REST dentro do sistema.