0. Visão geral da API
API (Application Programming Interface) é a forma segura e padronizada de outros sistemas se conectarem ao nosso sistema para consultar ou atualizar informações.
- Permite acessar dados como clientes, pedidos, veículos, documentos e produtos.
- Funciona de forma automática, sem acesso manual aos dados.
- Para utilizar, é necessário um código de autorização (token), garantindo que só usuários permitidos tenham acesso.
- Os dados são enviados e recebidos de forma organizada, usando JSON.
- Sempre utiliza conexão segura (HTTPS) para proteger suas informações.
Exemplo de uso: O sistema externo solicita a lista de clientes e recebe os dados de forma direta e segura, sem precisar acessar o sistema manualmente.
Especificações técnicas
| Item | Descrição |
|---|---|
| Padrão | Rest |
| Formato da requisição | JSON |
| Formato da resposta | JSON |
| Charset | UTF-8 |
| URL Base | https://erp.empresa.com.br/ERP/api.rule?sys=ERP |
| URL Homologação | https://erphom.empresa.com.br/ERP/api.rule?sys=ERP |
| Tipo de autenticação | Token ou Bearer JWT |
Resumo de uso da API
- Requisição de token através da apiauth.rule - Autenticação
- Quando não houver token válido (inexistente ou expirado)
- Consumo de um endpoint através da api.rule - API principal
Observações Para o uso da API Rest, é necessária a contratação da extensão T4ERP - Ext.APIGET