Introdução

A integração do IoT Hub no Tier 1 contempla basicamente a criação de
solicitações no sistema da Exati pelo fornecedor de IoT. Essa integração
consiste basicamente em duas operações de entrada e uma de saída:

[Entrada] Criação de solicitação

[Entrada] Cancelamento de solicitação

[Saída] Encerramento de solicitação

Operações de entrada

As operações de entrada são as requisições que o fornecedor de IoT precisa
enviar para criar ou cancelar a solicitação no sistema da Exati de acordo com os
alertas dos dispositivos.

Criar Solicitação

Nesta operação, o método cria uma solicitação no sistema da Exati. Após a requisição, a Exati retorna uma resposta indicando conformidade da operação. Para detalhes mais específicos da operação, verifique Criar Solicitação

Método	POST
Endpoint	/clients/:idInstance/tickets
Content-Type	application/json

Exemplo Corpo da Requisição


{
  "cod_external_ticket_origin": "tg",
  "ticket_origin_type_id": 1,
  "id_external_protocol": 1,
  "external_protocol": "string",
  "service_code": "string",
  "justification": "string",
  "description": "string",
  "id_worksite": 1,
  "state_abbreviation": "AC",
  "municipality": "string",
  "neighborhood": "string",
  "address": "string",
  "address_number": 0,
  "zip_code": "65903-350",
  "latitude": "45.123",
  "longitude": "76.486",
  "reference_point": "string",
  "reporter": "string",
  "reporter_phone": "84968718020",
  "reporter_birth_date": "01/01/1900",
  "nameplate_num": "string",
  "age_majority_checkbox": 1
}

Exemplo Corpo da Resposta

201 - Created


{
    "id_demanda": 12348,
    "operacao": "cria",
    "data_recebido": 1711217789710,
    "status": "ok",
}

Cancelar Solicitação

Nesta operação, o método cancela a solicitação no sistema da Exati. Após a requisição, a Exati retorna uma resposta indicando conformidade da operação. Para detalhes mais específicos da operação, verifique Cancelar Solicitação

Método	DELETE
Endpoint	/clients/:idInstance/tickets
Content-Type	application/json

Exemplo Corpo da Requisição


{
  "cod_external_ticket_origin": "tg",
  "id_external_protocol": 1,
  "justification": "string"
}

Exemplo Corpo da Resposta

200 - OK


{
    "id_protocolo": 12348,
    "operacao": "cancela",
    "data_recebido": 1711217789710,
    "status": "ok",
}

Operações de saída

As operações de saída são as requisições que a Exati envia para o fornecedor de
IoT para comunicar atualizações nas solicitações por ele criadas.

Encerrar solicitação

Para que essa operação seja implementada, é necessário que o fornecedor
disponibilize um endpoint que vá receber uma requisição no formato abaixo. A
operação de encerramento é enviada uma vez que a solicitação foi atendida.

Método	POST
Endpoint	[URL_TALQ]/<endpoint>
Content-Type	application/json

Corpo da Requisição

Abaixo, a tabela apresenta os campos que serão enviados na requisição desta
operação, no formato JSON:

Campo	Tipo	Descrição
operacao	String	Tipo de operação da requisição, que neste caso é “encerra”
origem	String	Código de origem da ocorrência externa cadastrada na tela de Origens ocorrência externa no sistema da Exati
id_protocolo	Integer	Identificação do protocolo
justificativa	String	String de descrição do motivo de encerramento da solicitação

Exemplo da requisição


curl -u user:password -X POST "https://[URL_TALQ]/<endpoint>" \
     -H "Content-Type: application/json" \
     -d '{
           "operacao": "encerra",
           "id_protocolo": 1,
           "justificativa": "teste",
           "origem": "tg"
         }'

Visão Geral

Introdução#

Operações de entrada#

Criar Solicitação#

Cancelar Solicitação#

Operações de saída#

Encerrar solicitação#

Corpo da Requisição#

Exemplo da requisição#