Magento 2 APIs – Como usar (com exemplos)

O Magento 2 possuí APIs riquíssimas que nos permitem integrar aplicações de praticamente qualquer tipo. É possível criar pedidos, produtos, atualizar estoque, executar operações em massa, e muito mais.

O que você vai ver aqui (índice):

• Os 3 tipos de API do Magento 2
• Como se autenticar na API
  • Criando token de integração
  • Usando endpoints de autenticação
• Lista de endpoints das APIs REST do Magento 2
• 16 exemplos de chamadas (para Postman)
• Onde encontrar mais de 600 exemplos de chamadas e aulas sobre a API do Magento

3 tipos de APIs

O Magento 2.3+ possuí nativamente 3 tipos de APIs:

• SOAP
• REST
• GraphQl

Embora o GraphQl seja o tipo mais “bacana” e com muitas vantagens e benefícios, no momento que escrevo este artigo ela ainda não tem uma cobertura confiável e completa no Magento.

O SOAP e Rest são os tipos mais populares, sendo que a segunda tem se tornado a mais popular e recomendada ao longo dos últimos anos.

É da API REST que falaremos aqui.

Autenticação

A autenticação é passada aos endpoints da API através de um header de autenticação (Authorization) contento o valor “Bearer ” + Token. Veja o exemplo cURL abaixo:

curl 'https://magento2.magenteiro.com/index.php/rest/V1/customers/1' --header 'Authorization: Bearer 4771rgrjsju5loq3n9ty870elht9fh1p'

O token em questão pode ser obtido de 3 formas diferentes:

1. Gerando-o através de uma nova integração

Uma das formas mais comuns é através da criação de uma nova integração. Isto é feito no menu System > Extensions > Integrations, como podemos ver no vídeo abaixo.

2. Através das endpoints de autenticação

Outra forma de se obter um token é nos endpoints de autenticação, onde podemos passar as credenciais de um usuário do admin, ou de um cliente da loja em formato JSON.

Endpoint de cliente: /rest/V1/integration/customer/token

Exemplo: curl -X POST 'https://magento2.magenteiro.com/index.php/rest/V1/integration/customer/token' --header 'Content-Type: application/json' --data-raw '{ "username": "[email protected]", "password": "[email protected]" }'

Endpoint de admin: /rest/V1/integration/admin/token

Exemplo: curl -L -X POST 'https://magento2.magenteiro.com/index.php/rest/V1/integration/admin/token' -H 'Content-Type: application/json' --data-raw '{ "username": "USUARIO", "password": "XXXXX"}'

Cada endpoint exige um tipo de token

Dependendo do endpoint que deseja acessar, será necessário usar um token administrador, enquanto em outros é necessário um token de cliente.

Por exemplo, no endpoint /rest/V1/customers/me, é exibido informações do cliente atual. Para isso é necessário um token de cliente final e não de administrador (como no endpoint /rest/V1/customers/:customerId).

Lista de endpoints da API

A lista completa dos endpoints do Magento pode ser encontrada conforme abaixo:

• Endpoints que exigem credenciais de admin
• Endpoints que exigem credenciais de cliente
• Endpoints que não exigem credenciais (acesso anônimo)

16 exemplos de chamadas às APIs REST do Magento 2

Preparei uma amostra de chamadas em uma coleção do Postman. Você pode obviamente exportar cada exemplo para a linguagem que quiser dentro da ferramenta.

Para fazer download da coleção e instruções básicas de uso, basta informar seu nome e e-mail. Ela será enviada por e-mail pra você nos próximos minutos.

Procurando Magento 1.x?
Confira esta lista de exemplos da API Soap para Magento 1.x.

650+ exemplos de uso da API Magento

Uma coleção ainda maior, e com explicações detalhadas sobre uso da API em massa (bulk api) do Magento está disponível no novo Mini Curso Magento APIs do Magenteiro.

Além dos 16 exemplos acima, a coleção incluí:

• Criação de pedidos como visitante e como usuário logado
  • Criação da quote (carrinho)
  • Adicionar itens no carrinho
  • Estimativa de frete
  • Definição de endereço de cobrança e entrega
  • Criação do pedido
  • Criação da Fatura (pagamento)
  • Envio do produto
  • Reembolso
  • Manipulação de carrinho
• Produtos configuráveis
• Pacote de produtos (Bundle)
• Gerenciamento de catálogo
  • Criação e edição de produtos
  • Criação e gestão de produtos configuráveis
• Atualizações em massa
  • Obtendo status da operação em massa
  • Criação de clientes em massa
  • Atualização de estoque em massa
  • Criação de produto simples em massa
  • Exclusão de produtos em massa
• API de Busca
  • Busca de produtos como visitante
  • Busca de produtos como admin

Além de aulas contando comentadas sobre vários destes exemplos, explicações detalhadas sobre a API, e acesso à uma loja demo para testar suas chamadas. São ao menos 85+ exemplos criados por mim, e outras centenas de exemplos que incluem as API’s dos módulos já existentes na sua própria loja.

• Sobre
• Últimos Posts

Ricardo Martins

É desenvolvedor web há 16 anos e um dos primeiros certificados pela Magento no Brasil. Instrutor de mais de 11 cursos Magento (os principais no magenteiro.com/cursos) com mais de 14 mil alunos de 105 países, é também criador do módulo PagSeguro Transparente, usado em mais de 12 mil lojas.

Últimos posts por Ricardo Martins (exibir todos)

• PagSeguro (PagBank) para Magento 1 recebe a Nova Geração - 9 de abril de 2024
• Recorrência no WooCommerce Sem Plugins Pagos - 28 de janeiro de 2024
• Chargeback. O que é, e como se livrar deles. - 19 de dezembro de 2023