Integração via API REST no MageUp para conectar qualquer sistema
O Magento 2 expõe uma API REST nativa e documentada que permite que sistemas externos — ERPs, CRMs, plataformas de logística, marketplaces e aplicativos — leiam e gravem dados da loja de forma segura e escalável. No painel MageUp você cria as integrações diretamente pelo admin, sem precisar acessar o servidor: gere o token de acesso, defina as permissões por recurso (ACL) e conecte qualquer sistema ao seu Magento em minutos.
O que a API REST do Magento permite fazer
A API REST nativa expõe centenas de endpoints cobrindo todos os domínios da loja, com respostas em JSON e autenticação via token.
Catálogo de produtos
Liste, crie, atualize e exclua produtos via endpoints /V1/products. Sincronize preços, estoque (/V1/stockItems), imagens e atributos personalizados diretamente do seu ERP ou sistema de gestão. Suporta produtos simples, configuráveis, agrupados, virtuais e para download — cada tipo com seus parâmetros específicos na mesma API.
Pedidos e faturamento
Consulte pedidos por status, data ou cliente via /V1/orders com filtros em searchCriteria. Crie faturas (/V1/invoices), remessas (/V1/shipments) e credit memos (/V1/creditmemos) programaticamente — ideal para integrar com sistemas de fulfillment que precisam confirmar expedições e atualizar status de pedido.
Clientes e endereços
Consulte e sincronize clientes via /V1/customers: crie contas, atualize dados cadastrais, gerencie endereços e associe clientes a grupos de preço. Útil para CRMs que precisam manter o cadastro de clientes sincronizado entre o Magento e a plataforma de relacionamento sem importações manuais via CSV.
Carrinho e checkout headless
Use a API de cart (/V1/carts) para criar carrinhos de convidados ou clientes autenticados, adicionar itens, aplicar cupons e finalizar pedidos programaticamente. Esse fluxo é a base para integrações de checkout headless, aplicativos mobile e quiosques físicos que precisam usar o catálogo e o checkout do Magento com uma interface personalizada.
Autenticação por token de integração
Cada integração externa recebe um token de acesso gerado no admin em Sistema → Integrações. O token é enviado no header Authorization: Bearer <token> em cada requisição. Diferente das credenciais de admin, o token de integração tem escopo limitado pelas permissões ACL configuradas e pode ser revogado a qualquer momento sem afetar o acesso ao painel.
Documentação Swagger integrada
O Magento gera automaticamente uma documentação interativa Swagger em /swagger listando todos os endpoints disponíveis com seus parâmetros, tipos e exemplos de resposta. Use a interface para testar chamadas de API diretamente no browser, antes de integrar no sistema externo, sem precisar de ferramentas como Postman para a exploração inicial.
Crie uma integração no admin em seis passos
Do zero ao token de acesso configurado no sistema externo, sem tocar em arquivos de servidor.
Acesse Sistema → Integrações
No admin do Magento, acesse System → Extensions → Integrations e clique em Add New Integration. Dê um nome descritivo para a integração (ex.: "ERP Omie", "CRM HubSpot") e preencha o campo Your Password com a senha do usuário admin atual para autorizar a criação.
Defina as permissões ACL
Na aba API, selecione os recursos que a integração pode acessar. Marque apenas o necessário: para um ERP de estoque, habilite Catalog Inventory e Products; para um hub de pedidos, habilite Sales → Orders, Invoices, Shipments. Permissões granulares reduzem o risco em caso de comprometimento do token.
Ative e copie o token
Salve a integração e clique em Activate. O Magento exibe os quatro valores de autenticação: Consumer Key, Consumer Secret, Access Token e Access Token Secret. Para o modelo mais simples (token bearer direto), use apenas o Access Token. Copie e guarde em um gerenciador de senhas — ele não é exibido novamente.
Configure o sistema externo
No sistema externo (ERP, CRM, plataforma de logística), configure a URL base da API do Magento (ex.: https://sujaloja.com.br/rest) e o token Bearer. Todas as requisições devem incluir o header Authorization: Bearer <seu-access-token> e Content-Type: application/json.
Teste com a documentação Swagger
Acesse https://sujaloja.com.br/swagger, clique em Autorizar e cole o token. Use a interface para fazer chamadas de teste nos endpoints que a integração vai utilizar — veja a estrutura exata do JSON de resposta e dos parâmetros de filtro (searchCriteria) antes de implementar no código do sistema externo.
Monitore e gerencie acessos quando necessário
Em Sistema → Extensões → Integrações, você visualiza todas as integrações ativas, a data de criação e o status. Para renovar o acesso de um sistema externo (ex.: por vazamento de token), clique em Reautorizar — o token antigo é invalidado imediatamente e novas credenciais são geradas, sem precisar alterar configurações de servidor. Para remover o acesso definitivamente (ex.: troca de fornecedor), clique em Excluir.
Autenticação, segurança e boas práticas
A API REST do Magento suporta diferentes mecanismos de autenticação para cada tipo de integração.
Tipos de token disponíveis
- Token de integração — gerado em Sistema → Integrações; escopo definido por ACL. Recomendado para sistemas externos (ERP, CRM).
- Token de admin — gerado via
POST /V1/integration/admin/tokencom user e password; acesso total. Evitar para integrações permanentes. - Token de cliente — gerado via
POST /V1/integration/customer/token; acesso restrito à conta do cliente. Usado em apps mobile autenticados. - Acesso de convidado — endpoints públicos (ex.: catálogo, preços) acessíveis sem token para vitrines headless.
Boas práticas de segurança
- Sempre use HTTPS — tokens em HTTP podem ser interceptados em trânsito.
- Crie uma integração por sistema externo, nunca compartilhe tokens entre sistemas diferentes.
- Conceda o menor escopo ACL possível — um sistema de logística não precisa de acesso a clientes ou preços.
- Armazene tokens no gerenciador de segredos do sistema externo (vault, variável de ambiente), nunca em código-fonte.
- Revogue e regenere tokens periodicamente ou imediatamente ao encerrar um contrato de serviço.
API REST no painel MageUp
Gerencie todas as integrações ativas, gere tokens e revogue acessos diretamente pelo painel, sem precisar acessar o servidor.
Com o MageUp você conecta ERPs, CRMs, plataformas de logística e marketplaces ao seu Magento via API REST nativa — sem modificar código e sem acessar o servidor. Crie a integração no admin, defina as permissões por recurso, copie o token e seu sistema externo começa a sincronizar produtos, pedidos e clientes imediatamente. Revogue acessos com um clique quando necessário.
COMECE AGORA!