Exemplos de uso das fonte de dados REST
Pré-requisito
- Acesso ao menu Gerenciamento de fontes de dados > Fonte de dados > REST (DI001).
Apresentação
Este artigo apresenta exemplos das fontes de dados REST.
Os exemplos descritos nesta seção contêm dados reais e podem ser aplicados em qualquer instância SoftExpert Suite. Com isso, ao segui-los, será possível cadastrar e consumir dados de fontes REST de exemplo.
Nesta seção, estão disponíveis também os dados dos serviços utilizados nos cadastros.
Cadastro de serviço com autenticação OAuth Client Credencials
1. Acesse o menu Gerenciamento de fontes de dados > Fonte de dados > REST (DI001).
2. Clique no botão 
.
3. Na etapa Dados do serviço REST, do assistente que será aberto, preencha os seguintes campos, da forma descrita na tabela abaixo:
| Identificador | sesuiteSampleOAuthService |
| Nome | SoftExpert Suite OAuth Service Sample |
| URL do serviço | https://<my-domain>/softexpert/rest/sample/oauth |
| Credencial |
Tipo de autenticação: Autenticação OAuth (Client Credentials) URL de acesso ao token: https://<my-domain>/softexpert/rest/sample/oauth/token Client ID: idsample Client Secret: somesecret |
O trecho das URLs em que consta <my-domain> deve ser alterado para o domínio do ambiente em que a fonte está sendo criada.
4. Clique no botão Próximo, ao fim da configuração de cada etapa.
5. Na etapa Parâmetros de entrada, preencha somente o método como GET.
6. Na etapa Parâmetros de saída, inclua o corpo de resposta conforme o exemplo a seguir:
{
"message": "string",
"status": 0
}7. Avance a etapa Segurança, sem realizar nenhuma configuração nela.
8. Na etapa Resumo, é possível verificar as configurações realizadas nas etapas anteriores. Clique no botão Teste de consumo para realizar um teste do serviço registrado. Na tela que será aberta, clique no botão Executar.
9. Sua fonte de dados está devidamente configurada e funcionando corretamente! Clique no botão Finalizar para concluir seu registro.
Cadastro de serviço com método GET
1. Acesse o menu Gerenciamento de fontes de dados > Fonte de dados > REST (DI001).
2. Clique no botão .
3. Na etapa Dados do serviço REST, do assistente que será aberto, preencha os seguintes campos, da forma descrita na tabela abaixo:
| Identificador | sesuiteSampleCompanyServiceQuery |
| Nome | SoftExpert Suite Company Service Query Sample |
| URL do serviço | https://<my-domain>/softexpert/rest/sample/company |
O trecho das URLs em que consta <my-domain> deve ser alterado para o domínio do ambiente em que a fonte está sendo criada.
4. Clique no botão Próximo, ao fim da configuração de cada etapa.
5. Na etapa Parâmetros de entrada, preencha os campos com os seguintes valores:
- Método: GET
- Identificador: term
- Parâmetro: QUERY
- Tipo: STRING
6. Na etapa Parâmetros de saída, inclua o corpo de resposta conforme o exemplo a seguir:
[
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}
]7. Avance a etapa Segurança, sem realizar nenhuma configuração nela.
8. Na etapa Resumo, é possível verificar as configurações realizadas nas etapas anteriores. Clique no botão Teste de consumo para realizar um teste do serviço registrado. Na seção Consulta da tela que será aberta, preencha o seguinte parâmetro:
- term: canada
9. Clique no botão Executar.
10. Sua fonte de dados está devidamente configurada e funcionando corretamente! Clique no botão Finalizar para concluir seu registro.
Cadastro de serviço com método POST
1. Acesse o menu Gerenciamento de fontes de dados > Fonte de dados > REST (DI001).
2. Clique no botão .
3. Na etapa Dados do serviço REST, do assistente que será aberto, preencha os seguintes campos, da forma descrita na tabela abaixo:
| Identificador | sesuiteSampleCompanyServiceInsert |
| Nome | SoftExpert Suite Company Service Insert Sample |
| URL do serviço | https://<my-domain>/softexpert/rest/sample/company |
O trecho das URLs em que consta <my-domain> deve ser alterado para o domínio do ambiente em que a fonte está sendo criada.
4. Clique no botão Próximo, ao fim da configuração de cada etapa.
5. Na etapa Parâmetros de entrada, preencha os campos com os seguintes valores:
- Método: POST
- Corpo de requisição:
{
"companyName": "string",
"state": "string",
"country": "string"
}6. Na etapa Parâmetros de saída, inclua o corpo de resposta conforme o exemplo a seguir:
[
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}
]7. Avance a etapa Segurança, sem realizar nenhuma configuração nela.
8. Na etapa Resumo, é possível verificar as configurações realizadas nas etapas anteriores. Clique no botão Teste de consumo para realizar um teste do serviço registrado. Na seção Corpo da requisição da tela que será aberta, preencha os seguintes parâmetros:
- companyName: CT - COMPANY FOR TESTS
- state: SHANDONG
- country: CHINA
9. Clique no botão Executar.
10. Sua fonte de dados está devidamente configurada e funcionando corretamente! Clique no botão Finalizar para concluir seu registro.
Dados do serviço de exemplo
O Serviço Company é um serviço que simula a manipulação de informações sobre dados de corporações fictícias e está disponível para ser utilizado na fonte de dados REST.
Veja a seguir os endpoints disponíveis:
Recuperar todas as corporações
- URL: https://<my-domain>/softexpert/rest/sample/company
- Método: GET
- Corpo de resposta:
[
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}
]
Filtrar corporações
- URL: https://<my-domain>/softexpert/rest/sample/company/query
- Método: GET
- Parâmetros (Query Params): NOME: term / TIPO: texto
- Corpo de resposta:
[
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}
]
Filtrar corporações com faixa de valor
- URL: https://<my-domain>/softexpert/rest/sample/company/between
- Método: GET
-
Parâmetros (Query Params):
◦ NOME: minID / TIPO: numérico
◦ NOME: maxID / TIPO: numérico - Corpo de resposta:
[
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}
]
Inserir nova corporação
- URL: https://<my-domain>/softexpert/rest/sample/company
- Método: POST
- Corpo de requisição:
{
"companyName": "string",
"state": "string",
"country": "string"
}- Corpo de resposta:
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}A corporação inserida não será realmente persistida, nem salva em memória, sendo apenas um exemplo simulando a inserção de um registro.
Atualizar corporação
- URL: https://<my-domain>/softexpert/rest/sample/company
- Método: PUT
- Corpo de requisição:
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}- Corpo de resposta:
{
"identifier": 0,
"companyName": "string",
"state": "string",
"country": "string"
}A corporação inserida não será realmente atualizada, é apenas um exemplo simulando a atualização de um registro. Caso não seja passado um identificador válido, nada é retornado.
Remover corporação
- URL: https://<my-domain>/softexpert/rest/sample/company
- Método: DELETE
- Corpo de resposta:
{
"message": "string"
}A corporação inserida não será realmente removida, é apenas um exemplo simulando a remoção de um registro.
O trecho das URLs em que consta <my-domain> deve ser alterado para o domínio do ambiente em que a fonte está sendo criada.
Conclusão
Pronto! Agora você conhece um exemplo de cadastro de fonte de dados com métodos GET e POST e de serviços que poderão ser consumidos com sucesso.