Skip to main content

​
Bem-vindo à API da Mginex

A API pública da Mginex permite que você integre sua loja com sistemas externos, automatize processos e crie experiências personalizadas para seus clientes.

Endpoints da API

Visualizar especificação OpenAPI completa

​
Autenticação

Todos os endpoints da API requerem autenticação via Bearer Token. Para obter seu token:
  1. Acesse o painel da Mginex
  2. Vá em Configurações > Open API
  3. Clique em Gerar Novo Token
  4. Copie e guarde seu token em local seguro
Seu token de API é secreto e não deve ser compartilhado. Ele dá acesso total à sua loja.

​
Exemplo de requisição autenticada

curl -X GET "https://api.mginex.com/open-api/catalog/product" \
  -H "Authorization: Bearer seu_token_aqui" \
  -H "Content-Type: application/json"

​
Estrutura das Respostas

Todas as respostas da API seguem um padrão consistente:

​
Resposta de sucesso

{
  "success": true,
  "data": {
    // dados da resposta
  }
}

​
Resposta de erro

{
  "success": false,
  "errorName": "NOME_DO_ERRO"
}

​
Rate Limiting

A API possui limites de requisições para garantir estabilidade:
  • 100 requisições por minuto por token
  • Requisições excedentes retornarão status HTTP 429

​
Recursos Disponíveis

Produtos

Gerenciar produtos da sua loja: listar, criar, atualizar e deletar

Categorias

Organizar produtos em categorias

Cupons

Criar e gerenciar cupons de desconto

Pedidos

Acompanhar e gerenciar pedidos

​
Códigos de Status HTTP

CódigoDescrição
200Requisição bem-sucedida
400Erro de validação ou requisição inválida
401Token de autenticação inválido ou ausente
404Recurso não encontrado
429Limite de requisições excedido
500Erro interno do servidor