Seja bem-vindo à documentação oficial das APIs da Plataforma JET. Aqui, você encontrará todos os recursos necessários para integrar sistemas externos com nossos serviços, de forma prática, segura e escalável.
Nossas APIs RESTful estão organizadas por domínios de negócio, facilitando o entendimento e a implementação das funcionalidades disponíveis. Por meio dessas interfaces, é possível consultar, cadastrar, atualizar e gerenciar informações essenciais para o funcionamento das suas soluções, como produtos, pedidos, promoções, configurações e muito mais.
URL Base Open API
https://openapi.plataformaneo.com.br
Abaixo, você pode acessar a documentação Swagger de cada módulo:
🔹 API de Configurações (Config)
Autenticação
Para realizar os requests em nossa Open API, é necessário utilizar um API Key. no HEADER de qualquer requisição.
| Key | Value |
|---|---|
| apiKey | {suaApiKey} |
| Content-Type | application/json |
Rate Limit
Nossa Open API utiliza um limitador de requests de 200 chamadas por minuto e 4 por segundos
caso atingir este limite você recebera uma resposta HTTP 429 Too Many Requests
Código Externo (externalCode)
O campo externalCode em nossa Open API é um código de controle do ERP Integrador.
Caso o ERP não queira utilizar os IDs da plataforma Jet, as consultas e gerenciamento podem ser feitas através deste campo.
Objeto de Retorno padrão
Utilizamos um objeto padrão de resposta para todos os end-points da nossa API:
{
"success": true,
"message": {
//dictonary <string, string>
},
"result": {
//objeto dinamico
},
"processingTime": "string"
}Suporte
Caso encontre dificuldades durante o processo de integração ou precise de apoio técnico, nossa equipe de suporte está disponível para ajudar.