O Gerenciamento de APIs no TOTVS iPaaS permite que os clientes acessem APIs para automatizar processos e reduzir tarefas manuais dentro da plataforma. Com essa funcionalidade, os usuários poderão criar credenciais de acesso e utilizá-las para consumir APIs de forma segura.

A intenção é que tenhamos mais APIs, que servirão para ampliar as possibilidades de automação e integração. 

Referência de API

Nesta aba, exibiremos exemplos de como o usuário poderá utilizar a API dentro do iPaaS. Nas categorias, serão exibidos os endpoints disponiveis com uma descrição detalhada. 

Exemplo de uso da API em consulta de mensagens

A API de consulta de mensagens permite recuperar informações detalhadas sobre uma mensagem no iPaaS utilizando o messageId. Esse identificador corresponde ao campo Identificador da tabela do monitor. Além disso, para garantir mais segurança, o tenantId da empresa já é automaticamente inserido na URL, eliminando a necessidade de incluí-lo manualmente na requisição.

Requisição:
Para consultar uma mensagem, utilize o endpoint abaixo, substituindo {id} pelo Identificador da mensagem no monitor:

Com essa API, é possível verificar o status da mensagem, visualizar os dados processados e acessar logs diretamente, sem precisar abrir o monitor manualmente.

Códigos de Status HTTP:

• 200 OK - Requisição bem-sucedida. O corpo da resposta varia conforme o status da mensagem.
• 401 Unauthorized - Chave de autenticação inválida ou ausente.
• 404 Not Found - O messageId fornecido não foi encontrado.

Retornos possíveis (Status Code 200)
Abaixo estão os diferentes formatos de resposta que a API pode retornar quando o status é 200.

1. Status: DONE (Mensagem processada com sucesso)

{
  "id": "<messageId>",
  "diagramName": "<Nome do Diagrama>",
  "initialComponent": "<Componente Inicial>",
  "projectName": "<Nome do Projeto>",
  "diagramVersion": "<Versão do Diagrama>",
  "createdDate": "<Data de Criação>",
  "updatedDate": "<Data de Atualização>",
  "executionTime": <Tempo de Execução>,
  "status": "DONE",
  "inMessage": "<Mensagem de Entrada>",
  "outMessage": "<Mensagem de Saída>",
  "finalComponent": "<Componente Final>"
}

2. Status: ERROR (Mensagem com falha no processamento)

{
  "id": "<messageId>",
  "diagramName": "<Nome do Diagrama>",
  "initialComponent": "<Componente Inicial>",
  "projectName": "<Nome do Projeto>",
  "diagramVersion": "<Versão do Diagrama>",
  "createdDate": "<Data de Criação>",
  "updatedDate": "<Data de Atualização>",
  "executionTime": <Tempo de Execução>,
  "status": "ERROR",
  "inMessage": "<Mensagem de Entrada>",
  "finalComponent": "<Componente Final>"
}

3. Status: PROCESSING (Mensagem em processamento)

{
  "id": "<messageId>",
  "diagramName": "<Nome do Diagrama>",
  "initialComponent": "<Componente Inicial>",
  "projectName": "<Nome do Projeto>",
  "diagramVersion": "<Versão do Diagrama>",
  "createdDate": "<Data de Criação>",
  "updatedDate": "<Data de Atualização>",
  "executionTime": <Tempo de Execução>,
  "status": "PROCESSING",
  "inMessage": "<Mensagem de Entrada>",
  "finalComponent": "<Componente Final>"
}

4. Status: REPROCESSED (Mensagem reprocessada)

{
  "id": "<messageId>",
  "diagramName": "<Nome do Diagrama>",
  "initialComponent": "<Componente Inicial>",
  "projectName": "<Nome do Projeto>",
  "diagramVersion": "<Versão do Diagrama>",
  "createdDate": "<Data de Criação>",
  "updatedDate": "<Data de Atualização>",
  "executionTime": <Tempo de Execução>,
  "status": "REPROCESSED",
  "reprocessMessageId": "<Novo MessageId Criado>",
  "inMessage": "<Mensagem de Entrada>",
  "outMessage": "<Mensagem de Saída>",
  "finalComponent": "<Componente Final>"
}

Credenciais de API

Nesta aba, o usuário pode criar e excluir chaves de API, que são utilizadas para autenticar chamadas às APIs do iPaaS. Cada credencial deve estar associada a pelo menos um escopo de acesso. 

Criação chave API

Para gerar uma nova credencial, siga os passos a seguir: 

01. Acione Cadastrar credencial;

02. No campo Nome, informe um nome para a credencial;

03. No campo Escopo, associe a credencial a pelo menos um escopo;

04. Em Data de expiração, habilite a opção caso deseje definir uma data de expiração automática para a credencial. Não sendo possível alterar a data após a criação.

05. Acione Cadastrar.

Copiar e armazenar a chave API

Após criar a credencial, a chave de API será exibida uma única vez em um modal de confirmação. 

Excluir credencial

01. Localize a credencial que deseja excluir;

02.  Em Ações, acione o botão da lixeira para excluir;

03. Na tela de confirmação, acione Excluir.