Histórico da Página
Índice | ||
---|---|---|
|
Ao cadastrar um aplicativo no TOTVS iPaaS é necessário que este aplicativo tenha um serviço associado a ele. Explicaremos abaixo como é feito para cadastrar um serviço em um aplicativo personalizado.
Cadastrar serviço
Para cadastrar um serviço no TOTVS iPaaS, siga os passos abaixo:
01. Com a tela de de aplicativos aberta, clique sobre o aplicativo personalizado que deseja cadastrar o serviço.
02. Clique na aba Serviços. Caso o aplicativo escolhido não tenha nenhum serviço cadastrado, clique em Cadastrar serviço localizado no centro do quadro da aba Serviços.
Painel | ||||
---|---|---|---|---|
| ||||
Caso o aplicativo já tenha serviços cadastrados, clique em Cadastrar serviço ao lado direito da tela e siga os passos abaixo. |
03. Insira as informações abaixo que são solicitadas:
Painel | ||||
---|---|---|---|---|
| ||||
|
04. Após inserir todas as informações, acione Cadastrar. Uma mensagem informando que o serviço foi cadastrado com sucesso será apresentada.
Adicionar recurso ao serviço
Após cadastrar um serviço, o TOTVS iPaaS direciona o usuário para adicionar recursos no serviço. Para isso siga os passos abaixo:
Aba Informações
01. Em Categoria do serviço, selecione a categoria do serviço (tag).
Painel | ||||
---|---|---|---|---|
| ||||
Também é possível cadastrar uma categoria (tag) clicando em Cadastrar categoria. Siga os passos abaixo para cadastrar uma categoria:
Uma mensagem informando que a categoria foi cadastrada com sucesso será apresentada. Editar categoria
Excluir categoria
|
02. Insira uma descrição para o recurso que está sendo adicionado.
03. Selecione o método da API sendo: DELETE, GET, PUT, POST e PATCH.
04. Insira o path.
Painel | ||||
---|---|---|---|---|
| ||||
O que é um path? Path é o caminho do serviço que irá complementar com a URL do ambiente. |
05. Acione Salvar para adicionar o recurso.
Aba Request
01. Na aba Request adicione o header, caso não tenha nenhum header adicionado, acione o botão Adicionar header.
Painel | ||||
---|---|---|---|---|
| ||||
Adicionar header
|
02. Expanda a aba Parameters e caso não tenha nenhum parâmetro adicionados clique em Adicionar parâmetro.
Painel | ||||
---|---|---|---|---|
| ||||
Adicionar parâmetro
|
03. Expanda a aba Body e caso não tenha nenhum campo adicionado, siga os passos abaixo:
04. No campo Content-type selecione qual content-type deseja utilizar.
05. No campo Charset informe o charset que deseja utilizar.
06. No campo Importar body request selecione o conteúdo que deseja utilizar.
07. No campo Descrição informe uma descrição.
Painel | ||||
---|---|---|---|---|
| ||||
Caso não tenha nenhum json adicionado, acione o botão Adicionar json. |
08. Uma tela para inserir o json será apresentada, após inserir o json clique em Salvar.
Dica |
---|
Para saber mais sobre Jolt acesse este material. |
Adicionar campo dentro de Body (inBody)
01. Clique em Adicionar campo, ao lado do botão Adicionar json.
02. Um novo campo inbody será apresentado. Insira as informações solicitadas:
- Campo: insira um nome para o campo;
- Data type: insira um tipo de valor, sendo: String, Integer, LONG, Object e Array;
03. Caso necessário incluir um campo interno, ou seja, que seja de um nível inferior ao campo que está acima, clique em Adicionar campo interno.
Painel | ||||
---|---|---|---|---|
| ||||
O que é a hierarquia de campos internos?
|
04. Caso necessário incluir um novo campo clique em Adicionar campo. adicionar um campo ao mesmo nível do campo que está acima.
Painel | ||||
---|---|---|---|---|
| ||||
O que é a hierarquia de campos?
|
Aba Response
01. Na aba Responde expanda o campo de Header.
02. Clique no botão Adicionar header.
03. Insira um nome para o header.
04. Caso haja necessidade de adicionar mais de um header, clique no botão Adicionar header.
Painel | ||||
---|---|---|---|---|
| ||||
Também é possível excluir os headers adicionados clicando no ícone |
05. Após adicionar o header expanda o campo Body.
06. Insira uma descrição.
07. Caso queira adicionar um campo clique em Adicionar campo.
Painel | ||||
---|---|---|---|---|
| ||||
Nessa etapa o funcionamento é o mesmo descritos nos painéis O que é a hierarquia de campos internos? e O que é a hierarquia de campos? descritos acima. |
08. Caso queira adicionar um json clique em Adicionar json.
09. Uma tela para inserir o json será apresentada, após inserir o json clique em Salvar.
10. Após inserir todas as informações das abas Informações, Resquest e Response, clique em Salvar.
Editar serviço
Depois de criar um serviço, podemos fazer sua edição. Para isso, siga os passos abaixo:
01. Com a tela de aplicativos aberta, clique sobre o aplicativo que deseja editar o serviço.
02. Clique na aba Serviços e logo depois clique no ícone
e escolha a opção Editar.03. Faça as edições necessárias e depois clique em Cadastrar.
Painel | ||||
---|---|---|---|---|
| ||||
Após finalização da edição do serviço, o usuário é redirecionado para a tela de Recursos onde é possível editar os recursos e as informações contidas nele: Editar recurso
Adicionar recurso
|
04. Caso não seja necessário fazer edições dos recursos clique em Concluir.
Excluir serviço
Para excluir um serviço no TOTVS iPaaS, siga os passos abaixo:
01. Com a tela de aplicativos aberta, clique sobre o aplicativo que deseja editar o serviço.
02. Clique na aba Serviços e logo depois clique no card do serviço que deseja excluir.
03. O serviço será aberto, clique no ícone
e escolha a opção Excluir.04. Uma mensagem informando que ao excluir o serviço todas as configurações associadas a ele serão perdidas. Clique em Excluir para confirmar a ação ou Cancelar para não confirmar a ação.
Editar categoria do serviço
No TOTVS iPaaS é possível editar as categorias criadas dentro dos serviços. Para isso, siga os passos abaixo:
01. Com a tela de aplicativos aberta, clique sobre o aplicativo no qual deseja editar a categoria do serviço.
02. Clique na aba Serviços. Os serviços criados serão apresentados em formato de cards.
03. Clique sobre o serviço no qual deseja editar a categoria.
04. As categorias do serviço serão listadas. Clique no ícone
para editar a categoria.05. Edite as informações desejadas. As informações que podem ser editadas são: Nome da categoria (tag) e Descrição da categoria (tag).
06. Após a edição clique em Salvar.
Excluir categoria do serviço
No TOTVS iPaaS é possível excluir as categorias criadas dentro dos serviços. Para isso, siga os passos abaixo:
01. Com a listagem de aplicativos aberta, clique sobre o aplicativo no qual deseja excluir a categoria do serviço.
02. Clique na aba Serviços. Os serviços criados serão apresentados em formato de cards.
03. Clique sobre o serviço no qual deseja excluir a categoria.
04. As categorias do serviço serão listadas. Clique no ícone
para excluir a categoria.05. Uma mensagem confirmando a ação será apresentada.
06. Para excluir a categoria clique em Excluir.
Painel | |||||
---|---|---|---|---|---|
| |||||
|
Editar recurso da categoria
Para editar o recurso cadastrado dentro da categoria, siga os passos abaixo:
01. Com a tela de aplicativos aberta, clique sobre o aplicativo no qual deseja editar o recurso da categoria.
02. Clique na aba Serviços. Os serviços criados serão apresentados em formato de cards.
03. Clique sobre o serviço no qual deseja editar o recurso cadastrado na categoria.
04. Expanda a categoria no ícone
ao lado direito do nome da categoria.05. No recurso cadastrado clique sobre o ícone
para editá-lo.06. Alterar as informações necessárias.
07. Após realizar as edições clique em Salvar.
Excluir recurso da categoria
Para excluir o recurso cadastrado dentro da categoria, siga os passos abaixo:
01. Com a listagem de aplicativos aberta, clique sobre o aplicativo no qual deseja excluir o recurso da categoria.
02. Clique na aba Serviços. Os serviços criados serão apresentados em formato de cards.
03. Clique sobre o serviço no qual deseja excluir o recurso cadastrado na categoria.
04. Expanda a categoria no ícone
ao lado direito do nome da categoria.05. No recurso cadastrado clique sobre o ícone
para excluí-loPainel | ||||
---|---|---|---|---|
| ||||
Uma mensagem informando que as configurações associadas ao recurso serão perdidas, caso elas existam. |
06. Para excluir o recurso clique em Excluir.