# Navixy Web Service

{% hint style="info" %}
**Categoria do Protocolo:** Protocolo de consolidação de dados
{% endhint %}

#### Índice

1. [O que é o Navixy Web Service?](#what-is-ws)
2. [Informações técnicas sobre o Navixy Web Service](#tech-info-ws)
3. [Configuração do Navixy Web Service](#ws-config)
4. [Configuração](#setting-up)
5. [Gerenciamento](#managing)
6. [Solução de problemas](#troubleshooting)

### O que é o Navixy Web Service?

**Navixy Web Service** o protocolo de reencaminhamento de dados transmite dados da frota do sistema Navixy para qualquer sistema de terceiros. O protocolo é flexível, permitindo que terceiros armazenem dados da frota em seus bancos de dados para usar para quaisquer finalidades ou para exibir dados em recursos web.

Como este protocolo de reencaminhamento de dados é independente de plataforma, seria a opção ideal para qualquer parceiro que trabalhe com arquivos XML.

### Informações técnicas gerais do Navixy Web Service

O protocolo Navixy Web Service utiliza SOAP para permitir a extração de dados em XML de dispositivos de rastreamento como parte da camada de aplicação do modelo OSI. Os dados são extraídos sob demanda.

Campos de dados que são enviados:

* `dateGPS`: Data e hora em UTC
* `ignition`: Status booleano da ignição
* `latitude`
* `longitude`
* `speedGPS`: km/h
* `unitPlate`: Placa
* `altitude`: Metros
* `course`: Direção do veículo, por exemplo: **N,S,E,O,NO,NE,SO,SE**
* `deviceId`: IMEI
* `numSat`: Número de satélites GNSS que o dispositivo está utilizando
* `odometer`: Distância percorrida em km
* `eventId`: o código de evento de acordo com o [ID de evento do Navixy Generic Protocol](https://www.navixy.com/docs/iot-logic-api/technologies/navixy-generic-protocol/navixy-generic-protocol-10/predefined-event-identifiers)

### Configuração do Navixy Web Service

#### Configuração

Para configurar o reencaminhamento de dados no protocolo Navixy Web Service:

1. Vá para **Dispositivos e configurações** na barra lateral esquerda.
2. Selecione o dispositivo necessário da **Objetos** lista.
3. Encontre o **Reencaminhamento de dados** portlet, expanda-o e clique <img src="https://2540041085-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F446mKak1zDrGv70ahuYZ%2Fuploads%2FYTTrY2faldTiBAuW5xjs%2Fimage.png?alt=media&#x26;token=49369c2e-6567-477b-a697-68b9f04d6740" alt="" data-size="line">.
4. Na janela aberta, clique em "+" para adicionar uma nova retransmissão.
5. No **Novo protocolo de retransmissão** diálogo, insira as informações exigidas. Para o protocolo Navixy Web Service, preencha os campos a seguir:

<table><thead><tr><th width="187.8182373046875">Parâmetro</th><th>Explicação</th></tr></thead><tbody><tr><td>Nome</td><td>Um rótulo descritivo para identificar esta configuração de retransmissão de dados. Insira um nome para tornar este retransmissor facilmente identificável.</td></tr><tr><td>Protocolo e Login</td><td>O protocolo de comunicação usado para retransmissão. Selecione <strong>Navixy Web Service</strong> no menu suspenso.</td></tr><tr><td>Endereço</td><td>A URL ou endereço IP do servidor de destino. <br><strong>Observação</strong>: Não é utilizado pelo Navixy Web Service, insira qualquer formato de endereço válido.</td></tr><tr><td><strong>Porta</strong></td><td>A porta de rede para conexão ao servidor de destino. <br><strong>Observação</strong>: Não é utilizada pelo Navixy Web Service, insira qualquer número de porta.</td></tr><tr><td>Login</td><td>Um identificador único para esta conexão do retransmissor. Insira qualquer login que ainda não esteja sendo usado por outro retransmissor em seu sistema.</td></tr><tr><td>Senha</td><td>Código de autenticação para esta conexão do retransmissor. Insira uma senha exclusiva para proteger esta configuração de retransmissão.</td></tr></tbody></table>

6. Ative o **Habilitado** interruptor para ativar a retransmissão de dados. O retransmissor não transmitirá nenhum dado enquanto estiver desativado.
7. A **tela de gerenciamento de retransmissão** deverá ser semelhante à seguinte, com o login e a senha do Navixy Web Service. Certifique-se de que o status esteja **Ativo** se desejar que este retransmissor envie dados.\
   ![](https://2540041085-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F446mKak1zDrGv70ahuYZ%2Fuploads%2FQGEbTqpYsEbgYGzHWkGZ%2Fimage.png?alt=media\&token=123de70b-ee18-49c3-8d75-9270b93fbde2)
8. Em seguida, o retransmissor precisará ser vinculado ao dispositivo. Para isso, habilite o interruptor com o nome do retransmissor necessário no **Reencaminhamento de dados** portlet. O ID Externo não é necessário para o protocolo Navixy Web Service.\
   ![](https://2540041085-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F446mKak1zDrGv70ahuYZ%2Fuploads%2FItDUjJHi4yGUOEbgU8QB%2Fimage.png?alt=media\&token=7cf34b91-38c4-4876-b7bc-fabc5224277d)

{% hint style="success" %}
Você criou e habilitou com sucesso um novo protocolo de retransmissão para este dispositivo. Agora o retransmissor está disponível para todos os dispositivos na conta; você pode habilitá-lo alternando o interruptor nas configurações de outros dispositivos.
{% endhint %}

#### Acesso externo:

Parâmetros requeridos:

* **Login e senha**: Estes devem corresponder às credenciais que você definiu na configuração do retransmissor
* **deviceIDs**: Máx. de 100
* **startDate** e **endDate**: Por exemplo, 9 de setembro de 2022 00:00 UTC até 11:59:59
  * UTC: 2022-09-01T00:00:00Z até 2022-09-01T11:59:59Z

A descrição do protocolo em WSDL pode ser encontrada abaixo, referente à localização do servidor:

UE <https://soap.navixy.com/LocationDataService?wsdl>

EUA <https://soap.us.navixy.com/LocationDataService?wsdl>

Uma requisição SOAP deve ser feita utilizando uma das páginas WSDL acima. A própria requisição XML é a seguinte, substituindo-se com as informações associadas:

{% code overflow="wrap" %}

```xml
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org">

   <soapenv:Header>
   <tem:authentication>
     <login>username</login>
     <password>password</password>
   </tem:authentication>
   </soapenv:Header>
   <soapenv:Body>
   <tem:dataRequest>
      <!--1 to 100 repetitions:-->
      <deviceIds>IMEI of device</deviceIds>
      <startDate>2022-08-30T00:00:00Z</startDate>
      <endDate>2022-08-31T00:00:00Z</endDate>
   </tem:dataRequest>
   </soapenv:Body>
</soapenv:Envelope>
```

{% endcode %}

Uma resposta de exemplo pode ser como esta:

```xml
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <ns:getLocationDataResponse xmlns:ns="http://tempuri.org">
            <result>
                <dateGps>2019-10-15T08:48:50.000Z</dateGps>
                <ignition>false</ignition>
                <latitude>75.9270866</latitude>
                <longitude>-85.5207616</longitude>
                <speedGps>0.0</speedGps>
                <unitPlate>JRT1550</unitPlate>
                <altitude>284.0</altitude>
                <course>N</course>
                <deviceId>866258048802349</deviceId>
                <numSat>15</numSat>
                <odometer>59845</odometer>
                <eventId>401</eventId>
            </result>
        </ns:getLocationDataResponse>
    </S:Body>
</S:Envelope>
```

#### Gerenciamento

Para editar ou interromper o reencaminhamento de dados, siga estes passos:

1. Em qualquer **Reencaminhamento de dados** portlet, clique <img src="https://2540041085-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F446mKak1zDrGv70ahuYZ%2Fuploads%2FsywdwHUv3nC9xsB9TxQb%2Fimage.png?alt=media&#x26;token=b9d357ed-802e-4665-afed-68677696d320" alt="" data-size="line"> para abrir a lista de protocolos disponíveis.
2. Clique <img src="https://2540041085-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F446mKak1zDrGv70ahuYZ%2Fuploads%2Fgit-blob-c74b4671ecb7f8c4b116ccce008860713f161424%2FUntitled-20250425-103233.png?alt=media" alt="" data-size="line"> para alterar as configurações do retransmissor, como nome, informações de login ou status habilitado.
3. Clique <img src="https://2540041085-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F446mKak1zDrGv70ahuYZ%2Fuploads%2Fgit-blob-3138d85bdcd004e511b7e7946fea783ff3e6a622%2Fimage-20250425-104605.png?alt=media" alt="" data-size="line"> e confirme para excluir um retransmissor

Todas as alterações são salvas automaticamente.

{% hint style="info" %}
Para habilitar/desabilitar um retransmissor para um determinado dispositivo, alterne o interruptor com o nome do retransmissor necessário no **Reencaminhamento de dados** portlet.&#x20;
{% endhint %}

#### Solução de problemas

Para verificar e testar sua requisição SOAP para a plataforma, é sugerido usar o SoapUI que pode ser encontrado aqui: <https://www.soapui.org/downloads/soapui/>

1. Instale o Soap UI
2. No menu Arquivo, selecione “New SOAP Project”
3. Cole o caminho correto no campo WSDL de acordo com o servidor e selecione **Create sample requests for all operations?**
4. EUA: <https://soap.us.navixy.com/LocationDataService?wsdl>
5. UE: <https://soap.navixy.com/LocationDataService?wsdl>
