# Instalação e Configuração do Suricato Rest

## Visão Geral

Este módulo orienta a instalação e parametrização do Suricato Rest para comunicação via API com ERPs em nuvem. 

O serviço já é compatível com outros ERPs de mercado, porém este manual aborda a integração TOTVS; *os tutoriais para as demais plataformas homologadas serão disponibilizados em breve.*

## Regra de Negócio

Para que o Suricato Cloud funcione corretamente, é obrigatório atender aos seguintes requisitos:

* **Instalação Prévia:** O sistema SURICATO deve estar previamente instalado.
* **Existência de Módulo:** O módulo `SURICATOTotvsRest` deve existir no diretório padrão de instalação.
* **Acessibilidade de Arquivo:** O arquivo `SURICATO-totvs-rest.jar` deve estar acessível para edição.
* **Parametrização de Propriedades:** O arquivo `application.properties.xml` deve ser configurado corretamente.
* **Alinhamento de Ambiente:** As configurações de conexão com o banco de dados devem ser preenchidas conforme o ambiente.
* **Ciclo de Atualização:** Após qualquer alteração no arquivo de configuração, o serviço deve ser reinstalado por meio da execução da `install.bat`.

*O não atendimento a esses requisitos pode impedir a comunicação REST entre o SURICATO e os sistemas TOTVS em ambiente cloud.*

## Como configurar e instalar o Serviço

{% stepper %}
{% step %}

#### Instalação e Configuração

Localize o diretório da aplicação utilizando o caminho abaixo:

```
C:\Program Files\Telematica\SURICATO\SURICATO-TOTVS\SURICATOTotvsRest
```

<figure><img src="/files/tT3WgBscFCsGWbXq011L" alt=""><figcaption><p><em>Exemplo – Diretório SuricatoTotvsRest</em></p></figcaption></figure>
{% endstep %}

{% step %}

#### Configuração do arquivo JAR

Abra o arquivo:

```
SURICATO-totvs-rest.jar
```

utilizando o WinRAR e localize o arquivo:

```
application.properties.xml
```

<figure><img src="/files/kBiTc6DVdaxaTFlrwWvR" alt=""><figcaption><p><em>Exemplo – Configurar Suricato totvs rest.jar</em></p></figcaption></figure>
{% endstep %}

{% step %}
O caminho para localizar o arquivo é o **Diretório Raiz** do arquivo `.jar`.

Clique sobre o arquivo `SURICATO-totvs-rest.jar` e utilize o WinRAR para extrair o arquivo.

<figure><img src="/files/lANO9yNo7Ng9Vwa6hRay" alt=""><figcaption><p><em>Exemplo – Configurar Suricato-ma.jar</em></p></figcaption></figure>
{% endstep %}

{% step %}

#### Configurando a conexão de banco

Edite o arquivo `application.properties.xml` extraído e configure a conexão com o banco de dados conforme o ambiente utilizado.

<figure><img src="/files/2kmluDsSAzbvODaLGikK" alt=""><figcaption><p><em>Configurando – Property SURICATO Cloud</em></p></figcaption></figure>
{% endstep %}

{% step %}
Após concluir as configurações do arquivo `application.properties.xml`, substitua o arquivo original dentro do `SURICATO-totvs-rest.jar`.

Em seguida, execute a **bat install** para que o serviço de marcação seja instalado corretamente.

<figure><img src="/files/C7p3QpPqfJOq4x8BEjtF" alt=""><figcaption><p><em>Instalando – Serviço SURICATO Cloud</em></p></figcaption></figure>
{% endstep %}
{% endstepper %}

## Glossário

* **Computação em Nuvem (Cloud Computing):** Modelo de computação que utiliza recursos de processamento, armazenamento e memória disponíveis remotamente por meio da Internet.
* **ERP:** Sistema de planejamento de recursos empresariais utilizado para integrar e gerenciar processos de negócio.
* **application.properties.xml:** Arquivo de configuração responsável por definir parâmetros de conexão e funcionamento da aplicação em ambiente cloud.

## FAQ – Perguntas Frequentes

<details>

<summary>O que acontece se eu não configurar corretamente o application.properties.xml?</summary>

A aplicação não conseguirá se conectar ao banco de dados e a comunicação REST não será realizada corretamente.

</details>

<details>

<summary>Preciso executar a bat install após alterar o arquivo de configuração?</summary>

Sim. Sempre que houver alteração no arquivo `application.properties.xml`, é necessário executar novamente a `bat install`.

</details>

<details>

<summary>Posso acessar o SURICATO TOTVS Cloud sem conexão com a Internet?</summary>

Não. O funcionamento da aplicação depende de acesso à Internet para comunicação em ambiente cloud.

</details>

<details>

<summary>Onde devo localizar o arquivo application.properties.xml dentro do .jar?</summary>

O arquivo está localizado no diretório raiz do `SURICATO-totvs-rest.jar`.

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://software-telematica-com.gitbook.io/suricato-docs/central-tecnica/instalacao-e-configuracao-de-servicos-do-suricato/instalacao-e-configuracao-do-suricato-rest.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.