Para iniciar a utilização da conexão por API, basta acessar o menu lateral na opção: APIs.

Aqui serão listadas todas as conexões que forem criadas. Você poderá adicionar uma nova conexão, editar uma já existente ou excluir uma que não quiser mais utilizar.

Como criar uma nova conexão por API?

Ao clicar no botão Adicionar, você será redirecionado para uma página contendo um formulário. Neste serão solicitados os seguintes campos:

• Nome
• Cabeçalho de Autenticação
• Chave de Autenticação
• URL

Obs: Todos os campos são obrigatórios, caso sua conexão não contenha Cabeçalho de Autenticação e Chave de Autenticação, basta inserir o traço: " - ", segue imagem de demonstração.

Como editar uma conexão por API existente?

Para editar uma conexão existente, basta clicar em Editar que você será redirecionado para uma página contendo todos os dados daquela conexão.

Após editar os dados necessários você poderá testar a conexão:

Caso estejam todos os dados preenchidos corretamente, será exibida mensagem de sucesso e você poderá salvar:

Sendo redirecionado para a página com a listagem das conexões exibindo uma mensagem de sucesso.

Como excluir uma conexão por API indesejada?

Quando houver uma conexão que não desejar e quiser excluir, você precisa apenas clicar em excluir.

Uma mensagem de confirmação será exibida:

Confirmando a exclusão, você será novamente direcionado a página de conexões exibindo uma mensagem de sucesso:

Como funcionam as mensagens de retorno da conexão por API?

Nós estaremos retransmitindo todas as mensagens de retorno criadas na conexão da API. Ou seja, quando a empresa criar e disponibilizar uma conexão por API, as mensagens de retornos precisarão ser criadas e tratadas, pois o PlugBot Nuvem apenas exibirá a mensagem que receber da consulta na API. 

Quais são as possíveis estruturas para a Conexão por API?

Estamos trabalhando inicialmente com 4 estruturas diferentes com até o terceiro nível de aninhamento.

Primeira estrutura:

{
  dados1: [
   {campo: resultado},
   {campo: resultado},
   {campo: resultado},
   {campo: resultado},
   {campo: resultado}
  ],
  dados2: [
   {campo: resultado},
   {campo: resultado},
   {campo: resultado},
   {campo: resultado},
   {campo: resultado}
  ]
}

Segunda estrutura:

[
  {campo: resultado},
  {campo: resultado},
  {campo: resultado},
  {campo: resultado},
  {campo: resultado}
]

{
  dados1: {
    campo: resultado
  },
  dados2: {
    campo: resultado
  }
}

{
  nivel1: {
    dados1: {campo: resultado},
    dados2: {campo: resultado},
    dados3: {campo: resultado},
    dados4: {campo: resultado},
    dados5: {campo: resultado}
  }
}

Como criar gráficos na Conexão por API?

Para criar novos gráficos utilizando a conexão por API, basta acessar o menu lateral na opção PlugDash > Gráficos. Os três primeiros passos são explicandos na documentação. Por isso vamos iniciar da parte onde selecionamos o tipo de conexão.

No 4º passo, você deverá selecionar a opção: API (BETA).

Na sequência, deve selecionar qual Conexão por API quer utilizar:

Feito isso, agora você deve selecionar o tipo de gráfico, informar o Título, Sub Título e o Intervalo de Sincronização. 

Dependendo da escolha do gráfico as configurações especificas do gráfico serão diferentes, portanto escolha o que mais se adequar ao seu trabalho.

Após o processo de configurar a visualização do gráfico, chegaremos a etapa de mapear propriedades.

Nessa etapa, será necessário inserir o nome da Aba e na sequência você deverá clicar no botão Fazer Requisição:

Enquanto estiver realizando a consulta, um icone de carregamento estará sendo apresentado sobre o botão. Caso retorne alguma mensagem de erro, volte o documento até a parte onde explicamos como funcionam os retornos.
Após finalizar a requisição o resultado será exibido na caixa abaixo:

Com o resultado sendo exibido, você deve agora mapear cada campo obrigatório do gráfico selecionado. Para mapear basta clicar no campo que deseja mapear e selecionar o dado no resultado da requisição que deseja vincular.

Na imagem acima, o campo NOME foi atribuído o dado NOME do resultado da requisição, assim como o campo INFO, que foi atribuído ao dado PADRÃO do resultado da requisição.

Para cada tipo de gráfico você poderá realizar essa mesma ação de acordo com os campos disponíveis no gráfico e no resultado da requisição.

Veja como ficou o gráfico com os mapeamentos acima:

Após esse processo, basta salvar e será exibido no PlugDash.