1.Integração M2M

Este documento descreve o funcionamento da integração de Telegestão entre Exati e M2M.

Aspectos Gerais

Objetivo

Este documento tem como objetivo principal fornecer uma explicação detalhada do modo de uso da integração de telegestão, a fim de mostrar as funcionalidades relacionadas a abertura e fechamento de solicitações, atualização de dispositivos de telemetria, etc.

Disposição da Documentação

Este documento contém um panorama geral da integração com as informações de uso da API de integração. A seguir, está o índice com todas as seções da documentação:

1.Integração M2M;

2.O que mudou;

3.Autenticação da API;

4.Operações de Entrada, disponibilizada pela Exati;

5.Operações de Saída, disponibilizada pela M2M;

Panorama Geral da Integração

API de Integração com a Exati

O acesso à API se dá pela URL e endpoints definidos abaixo. Estes são utilizados para o cadastro e inclusão de dados no sistema Exati.

URL Base

https://iot.exati.com.br/vendors/m2m

Endpoints

Todos os endpoints são relativos à URL Base, isto é, adiciona-se o endpoint ao final da URL apresentada na seção URL Base.

Exemplos:

Verbo HTTP	Endpoint	Descrição
POST	/clients/:idInstance/tickets	Criar uma nova solicitação
DELETE	/clients/:idInstance/tickets	Cancelar solicitação

Fluxos das Operações

Veja nesta seção os fluxogramas gerais das operações de entrada e de saída, e os diagramas dos principais fluxos da integração.

Fluxos Geral dos Pontos de Entrada

Abaixo, segue o diagrama que ilustra todos os pontos de entrada da API, isto é, todas as operações que a M2M pode realizar enviando requisições para a API da integração. Esses pontos estão detalhados em Operações de Entrada

Figura 1: Fluxo dos Pontos de Entrada

Fluxos Geral dos Pontos de Saída

Abaixo, está o fluxograma dos pontos de saída da integração, isto é, as chamadas feitas pela Exati à API da M2M. Esses pontos estão detalhados em 5.Operações de Saída.

IoT Hub - Operações de saída da integração.jpg

Figura 2: Fluxo dos Pontos de Saída

Fluxo de atualização de pontos com NOX

Abaixo está o fluxograma da atualização de pontos com NOX, isto é, toda a interação da Exati com a API da M2M para a atualização de pontos IP com NOX. Esse fluxo está detalhado em 2.O que mudou.

Figura 3: Fluxo de atualização de pontos com NOX

Aspectos Gerais#

Objetivo#

Disposição da Documentação#

Panorama Geral da Integração#

API de Integração com a Exati#

URL Base#

Endpoints#

Fluxos das Operações#

Fluxos Geral dos Pontos de Entrada#

Fluxos Geral dos Pontos de Saída#

Fluxo de atualização de pontos com NOX#