Connections

Para trabalhar com as suas APIs no Developer Portal, primeiramente é necessário importá-las por meio de uma conexão com uma API Gateway — que pode ser da Sensedia ou de terceiros.

Tal conexão (ou integração) permite a sincronização dos dados de suas APIs com o Developer Portal.

A tela Connections, acessível pelo menu lateral esquerdo, permite a configuração de novas conexões. Você também pode visualizar, editar ou excluir conexões já existentes.

Veja a seguir:

Criando uma nova conexão

Siga os passos abaixo para criar uma nova conexão.

Para gateways AWS: para criar uma conexão, você deve ter um usuário de conexão AWS no seu AWS Gateway e obter suas credenciais.

  1. Entre na tela Connections, clicando no menu lateral esquerdo ou no card na tela inicial do Portal Manager.
    screenshot da tela inicial do Portal Manager

  2. Clique no botão + CREATE CONNECTION, localizado na parte superior direita da tela.
    screenshot da tela connetions

  3. Na etapa 1 - PROVIDER, selecione o provedor da conexão.
    detalhe da tela de criação de conexão com a etapa 1

  4. Clique em NEXT.

  5. Na etapa 2 - CONNECTION, forneça as seguintes informações:

    • Connection mode: Selecione o modo de conexão: se é nativa (dados atualizados diretamente com o provedor) ou não (upload manual).

      A sincronização em conexões nativas depende das credenciais estarem cadastradas no provedor.

    • Connection name: Defina um nome para a conexão.

    • Para gateways Sensedia:

      • Manager Release: Selecione uma versão: API Platform 4.x ou API Management 5.x.

        • Para API Platform 4.x:

          • Manager domain: URL da sua Sensedia API Platform.

          • Token: seu token de acesso.

        • Para API Management 5.x:

    • Para gateways AWS:

  6. Na última etapa, revise as informações. Se estiverem corretas, clique em SAVE.

Este vídeo ilustra os passos para criar uma conexão com gateways AWS:

Em conexões com o Sensedia API Manager, as APIs são importadas automaticamente. Veja mais abaixo como importar APIs quando integrando com AWS API Gateways.

Exibindo detalhes da conexão

Para visualizar as informações gerais de uma conexão específica:

  1. Entre na tela Connections, clicando no menu lateral esquerdo ou no card na tela inicial do Portal Manager do Developer Portal.
    screenshot da tela inicial do Portal Manager

  2. Na tela Connections, clique no ícone ícone de um olho da conexão desejada.

  3. Veja na tela seguinte:

  4. Para ver detalhes da API e suas execuções, clique no ícone ícone de um olho da API.
    screenshot da tela de detalhes da conexão

Editando uma conexão

Siga os passos abaixo para editar uma conexão:

  1. Entre na tela Connections, clicando no menu lateral esquerdo ou no card na tela inicial do Portal Manager do Developer Portal.
    screenshot da tela inicial do Portal Manager

  2. Encontre a conexão que deseja editar e clique no ícone icon view 2.
    Se precisar, utilize a barra de busca para localizar a conexão desejada.

  3. Na parte superior direita de General Trace, clique no ícone icon edit.
    screenshot da tela de edição de conexão

  4. Faça as alterações necessárias e clique em SAVE.

Importando APIs

Para importar APIs, siga os passos abaixo:

  1. Entre na tela Connections, clicando no menu lateral esquerdo ou no card na tela inicial do Portal Manager do Developer Portal.
    screenshot da tela inicial do Portal Manager

  2. Encontre a conexão que deseja editar e clique no ícone icon view 2.
    Se precisar, utilize a barra de busca para localizar a conexão desejada.

  3. Na tela API Imports, clique no botão + IMPORT API, localizado logo abaixo de General Info e acima de API Imports.
    screenshot da tela de importação de APIs

  4. Para gateway AWS:

    • Selecione a região das APIs que deseja importar e clique em SAVE.
      screenshot da tela de importação de APIs para gateways AWS

    • Selecione as APIs que deseja importar e clique em SAVE.

Para gateway Sensedia, a importação das APIs é feita automaticamente na criação da conexão.

Listagem de conexões

As conexões já criadas são listadas na tela Connections.

Para cada conexão (linha), são exibidas as seguintes informações (colunas):

  • PROVIDER:

    • logo Sensedia API Gateway para gateways da Sensedia ou

    • logo AWS API Gateway para gateways AWS.

  • NAME: nome identificador da conexão.

  • MODE: modo de conexão, podendo ser NATIVE ou NON-NATIVE.

  • STATUS: estado da sincronização dos dados das APIs:

    • DONE, indicando que a sincronização dos dados foi concluída com sucesso;

    • IN PROGRESS, indicando que a sincronização está em andamento;

    • FAILED, que indica que a sincronização de uma ou mais APIs falhou;

    • SYNC NOT STARTED, indicando que o processo de sincronização ainda não foi iniciado;

    • NO IMPORTS, indicando que não há APIs importadas.

  • API COUNT: quantidade de APIs importadas.

  • LAST SYNC: data e horário da última sincronização.

Além dessas informações, a coluna ACTIONS traz os seguintes recursos:

  • icone de um olho: exibe informações gerais da conexão e permite editar suas configurações.

  • ícone de uma lixeira: permite excluir uma conexão.

Não é possível excluir conexões com estado IN PROGRESS e SYNC NOT STARTED.

É possível buscar por conexões específicas por meio dos seguintes campos, localizados acima da listagem:

  • Name: busca pelo nome da conexão.

  • Provider: busca pelo provedor.

  • Status: busca pelo estado da sincronização.

Após preencher os campos desejados, clique em SEARCH. Para limpar os campos preenchidos, clique em CLEAR. Para atualizar os resultados, clique em icone de recarregar

Detalhes da conexão

General Info

Para chegar na tela com os detalhes da conexão, onde General Info está, siga os passos descritos na seção "Exibindo detalhes da conexão".

detalhe da tela de connections com painel de general information

Esse painel exibe as seguintes informações sobre a conexão selecionada:

  • O estado da sincronização dos dados das APIs (no canto superior esquerdo):

    • DONE, indicando que a sincronização dos dados foi concluída com sucesso;

    • IN PROGRESS, indicando que a sincronização está em andamento;

    • FAILED, que indica que a sincronização de uma ou mais APIs falhou;

    • SYNC NOT STARTED, indicando que o processo de sincronização ainda não foi iniciado;

    • NO IMPORTS, indicando que não há APIs importadas.

  • Connection Name: nome da conexão.

  • Mode: modo de conexão, podendo ser NATIVE ou NON-NATIVE.

  • Created At: data e horário de criação.

  • Created By: nome do usuário responsável pela criação da conexão.

  • Updated At: data e horário da última atualização.

  • Updated By: nome do usuário responsável pela última atualização.

  • Last Executed At: data e horário da última sincronização de dados.

Para gateways Sensedia, além dos campos acima, são exibidos:

  • Manager Domain: URL do Sensedia API Manager

  • Token: seu token de acesso da Sensedia. Este dado não é exibido por questões de segurança.

Para gateways AWS, além dos campos acima, são exibidos:

  • AWS Access Key Id: chave de acesso do seu recurso AWS.

  • AWS Secret Access Key Id: segredo da chave AWS. Este dado não é exibido por questões de segurança.


API Imports

Abaixo do painel de informações gerais da conexão, há o painel API IMPORTS, no qual você pode gerenciar as importações das APIs para a conexão.

detalhe da tela integrations com o painel api imports

Listagem de importações

As APIs são listadas em uma tabela, que traz em suas colunas as seguintes informações:

  • NAME: nome da API;

  • REGION: região em que a API está implantada;

  • API ID: identificador da API;

  • PROTOCOL TYPE: protocolo de comunicação;

  • STATUS: estado da importação:

    • DONE: indicando que a importação foi finalizada com sucesso;

    • IN PROGRESS: indicando que a importação está em andamento;

    • FAILED, que indica que a sincronização de uma ou mais APIs falhou;

    • NOT STARTED: indicando que a importação ainda não foi iniciada.

Além dessas informações, a coluna ACTIONS traz os seguintes ícones/botões para que você possa:

  • icon refresh: atualizar os dados da importação. Não é possível atualizar uma importação com estado IN PROGRESS ou NOT STARTED.

  • icon view 2: mais informações sobre a importação.

  • icon delete: permite excluir a importação. Não é possível excluir uma importação com estado IN PROGRESS ou NOT STARTED.

É possível buscar por importações específicas por meio dos seguintes campos, localizados acima da tabela:

  • Name: busca pelo nome da API.

  • Status: busca pelo estado da importação.

Após preencher os campos desejados, clique em SEARCH. Para limpar os campos preenchidos, clique em CLEAR. Para atualizar a lista de APIs, clique em icone de recarregar

Visualizando detalhes de uma importação específica

Ao clicar no botão icon view 2 de uma importação específica na listagem de importações, é possível visualizar mais informações sobre essa importação.

Você será redirecionado para uma nova tela que contém dois painéis:

  • DETAILS, que exibe informações da importação;

  • EXECUTIONS, que exibe uma lista com informações sobre cada tentativa de sincronização dos dados da importação.

DETAILS

O painel DETAILS apresenta as seguintes informações sobre a importação:

  • API Id: identificador da API;

  • Name: nome da API;

  • Region: região em que a API está implantada;

  • Protocol Type: protocolo de comunicacão,

  • Status: estado da execução da última atualização da importação:

    • DONE: indicando que a importação foi finalizada com sucesso;

    • IN PROGRESS: indicando que a importação está em andamento;

    • FAILED, que indica que a sincronização de uma ou mais APIs falhou;

    • NOT STARTED: indicando que a importação ainda não foi iniciada.

  • Created At: data e horário da criação;

  • Created By: usuário responsável pela criação.

Você sabe se sua conexão é Sensedia (Sensedia) ou AWS (AWS) pelo ícone ao lado direito das informações.

EXECUTIONS

O painel EXECUTIONS exibe uma lista com informações sobre cada tentativa de sincronização dos dados da importação.

Aqui é possível ver:

  • STARTED BY: usuário que iniciou a execução da importação.

  • STATUS: estado da sincronização:

    • DONE: indicando que a sincronização dos dados foi concluída com sucesso;

    • IN PROGRESS: indicando que a sincronização está em andamento;

    • FAILED, que indica que a sincronização de uma ou mais APIs falhou;

  • REASON FOR FAILURE: motivo do erro, caso a sincronização tenha falhado.

  • TYPE: indica como a execução foi inicializada, se de modo automático (AUTOMATIC) ou manual (MANUAL).

  • Started At: data e horário do início.

  • Finished At: data e horário de finalização.

Ao clicar no ícone ícone de uma lupa sobre uma folha de papel de uma execução específica, é possível visualizar mais informações sobre ela na coluna ACTIONS:

  • Execution Id: identificador único da execução.

  • Log: mensagem do registro da execução.

Thanks for your feedback!
EDIT

Share your suggestions with us!
Click here and then [+ Submit idea]