Obtendo dados de clientes via API no Magento 2

Consumir a API REST do Magento 2 pode assustar quem está começando. No entanto, tudo ficou bem mais simples do que no seu antecessor, o Magento 1.

O artigo de hoje é uma sugestão enviada pelo Wagner Germinari, membro antigo da nossa comunidade de desenvolvedores Magento 2 aqui do Magenteiro.

Neste artigo vamos explorar os seguintes tópicos:

• Como gerenciar credenciais e fazer chamadas à API
• Como obter informações de um cliente específico
• Como obter informações do cliente atual
• Outros exemplos de uso da API

Obtenha e use as credenciais corretas

As chamadas às APIs do Magento se dividem em 3 tipos:

1. Anônimas – não requerem credenciais alguma para serem realizadas (ex: listar produtos de uma categoria)
2. Administrativas – requerem uma credencial de administrador (ex: atualizar estoque de um item)
3. Cliente – requerem uma credencial de cliente (ex: criar um carrinho p/ cliente logado)

Após obter uma credencial ela deverá ser usada no header ‘Authorization’ de suas chamadas. Ainda neste link você encontrará como obter sua credencial para consumir as APIs que vamos tratar neste artigo.

Obtendo informações do cliente específico

O endpoint que exibe informações de cliente está localizado em /customers.

O id do cliente que queremos é passado como primeiro parâmetro, ainda na url. Sendo assim, se quisermos obter informações do cliente cujo id é 1, chamaremos /customers/1.

Veja como ficaria o exemplo de chamada no Postman.

O exemplo acima poderia ser reproduzido no seu terminal usando cURL. Ficaria assim: curl -L -X GET 'https://magento2.magenteiro.com/index.php/rest/V1/customers/1' -H 'Authorization: Bearer vdntno4jhc3m5c9yrjspbty1mqruitn4'

Leembre-se de substituir o URL da loja pela sua (caso não esteja usando a nossa loja demo – exclusiva para alunos).

Obtendo informações do cliente logado

Para obter informações do cliente logado via API, basta usar o endpoint /customers/me.

A diferença é que neste caso você usará as credenciais de cliente e não de administrador. Enquanto o administrador pode ver todos os clientes, a credencial de cliente só permitirá acesso às suas próprias informações.

Exemplo: curl -L -X GET 'https://magento2.magenteiro.com/index.php/rest/V1/customers/me' -H 'Authorization: Bearer oy2gojtfzqhnkr3odll846v7f9m9hvjh'

Outros exemplos

Aqui no blog do Magenteiro você pode encontrar outros 16 exemplos de uso da API para Postman.

Se quiser ir além, considere se inscrever no Minicurso de APIs Rest para Magento 2, onde mergulhamos em mais de 600 exemplos de uso da API e explicações detalhadas sobre várias delas.

Tem algum caso de uso de API que gostaria de ver aqui? Deixe seu comentário.

• 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