# Sobre a API

## API da HighSoft

A API da HighSoft foi desenvolvida com o objetivo de fornecer uma interface robusta e segura para integração com o sistema ERP da HighSoft. Por meio dessa API, é possível acessar, cadastrar e editar dados diretamente no ERP, permitindo a automação de processos e a integração com sistemas externos.

### Funcionalidades

* **Acesso a dados**\
  Realize consultas a informações como clientes, produtos, pedidos, notas fiscais, estoque e outros módulos do ERP. As informações são retornadas em formato JSON para fácil leitura e integração.
* **Postagem de dados**\
  Crie novos registros no ERP, como pedidos de venda, lançamentos financeiros, movimentações de estoque, entre outros.
* **Edição de dados**\
  Atualize registros existentes com segurança, respeitando as regras de negócio e validações do sistema ERP.

### Características

* **Interface RESTful**: Comunicação via HTTP/HTTPS com estrutura REST.
* **Formato de dados**: JSON.
* **Segurança**: Autenticação por token, com controle de permissões e proteção de acesso.
* **Validação de regras de negócio**: Toda operação passa pelas validações definidas no ERP, garantindo integridade e consistência.

### Casos de uso

* Integração com e-commerces para sincronização de produtos, pedidos e estoque.
* Aplicações mobile de vendas com acesso em tempo real ao banco de dados do ERP.
* Sistemas de BI que consomem dados atualizados do ERP para geração de relatórios e dashboards.
* Conexão com soluções de automação logística e industrial.

### Tecnologias utilizadas

* **Delphi**
* **Horse (framework para criação de APIs REST)**

***

#### Arquivo de importação

{% file src="/files/s8RR96JSHI0KKFFqlxTA" %}


---

# 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://hsapi.highsoftsistemas.com.br/sobre.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.