Como trabalhar com a API REST do Wo­o­Com­merce

Você pode usar a API REST do Wo­o­Com­merce para acessar re­mo­ta­mente a área de ad­mi­nis­tra­ção da sua loja do Wo­o­Com­merce. Operações básicas como “Ler” e “Criar” são ge­ren­ci­a­das usando so­li­ci­ta­ções HTTP. A API do Wo­o­Com­merce pode ser ativada no backend.

O que é uma API REST?

REST APIs são usadas para definir quais recursos de um sistema podem ser ge­ren­ci­a­dos usando REST (Repre­sen­ta­ti­o­nal State Transfers). As APIs são uma ótima solução para permitir a co­mu­ni­ca­ção simples e eficiente entre cliente e servidor em sistemas baseados na Web. Cada recurso recebe pa­râ­me­tros mo­di­fi­cá­veis que descrevem o recurso. As ar­qui­te­tu­ras REST são re­a­li­za­das usando pro­to­co­los HTTP, que permitem que cada recurso seja en­de­re­çado usando um URI exclusivo.56529855/>URI exclusivo** (Uniform Resource Iden­ti­fier). Os pa­râ­me­tros são anexados como pa­râ­me­tros de URL e os recursos são con­tro­la­dos usando métodos HTTP padrão como GET, POST, PUT e DELETE.

Para que é usada a API REST do Wo­o­Com­merce?

A ca­rac­te­rís­tica mais im­por­tante da API REST do Wo­o­Com­merce é sua uni­ver­sa­li­dade. Seu design permite que as lojas do Wo­o­Com­merce interajam fa­cil­mente com outros sites e serviços. Essa in­te­ra­ti­vi­dade é útil não apenas para os de­sen­vol­ve­do­res, mas para todos os usuários do Wo­o­Com­merce. Aqui estão algumas das outras vantagens de usar a API REST do Wo­o­Com­merce:

• Acesso entre pla­ta­for­mas: a API REST permite que você use apli­ca­ti­vos de terceiros para acessar seu painel do Wo­o­Com­merce.
• In­te­gra­ção suave da lógica de negócios: software e hardware es­pe­cí­fi­cos do negócio, como wearables e dis­po­si­ti­vos de ras­tre­a­mento de IoT, podem ser fa­cil­mente in­te­gra­dos ao seu projeto usando a API do Wo­o­Com­merce.
• Sin­cro­ni­za­ção de dados otimizada: As empresas que desejam sin­cro­ni­zar dados entre sua loja Wo­o­Com­merce e outras pla­ta­for­mas e canais podem fazer isso usando a API REST do Wo­o­Com­merce.
• In­de­pen­dên­cia do backend do Wo­o­Com­merce: Depois de ativar a API universal do Wo­o­Com­merce, você não estará mais vinculado ao backend do Wo­o­Com­merce/WordPress. Você pode integrar e usar uma área de ad­mi­nis­tra­ção de sua escolha.
• Fácil in­te­gra­ção de dados de terceiros: você pode usar a API REST do Wo­o­Com­merce para acessar quaisquer dados de terceiros baseados em apli­ca­ti­vos.
• Conexão com apli­ca­ti­vos móveis: se quiser conectar sua loja Wo­o­Com­merce a um apli­ca­tivo móvel, você poderá fazer isso com a API do Wo­o­Com­merce.

Como usar a API REST do Wo­o­Com­merce passo a passo

Se você quiser usar a API do Wo­o­Com­merce para interagir com outros apli­ca­ti­vos e serviços da Web, primeiro precisará ativá-la gerando uma chave de API. Você também precisará instalar um cliente para acesso REST. Abaixo, mos­tra­re­mos esse processo passo a passo.

Etapa 1: geração de uma chave de API REST do Wo­o­Com­merce

A primeira etapa na con­fi­gu­ra­ção da API REST do Wo­o­Com­merce é gerar uma chave de API. A chave funciona como um tipo de controle de acesso e é usada pelo Wo­o­Com­merce para au­ten­ti­car so­li­ci­ta­ções REST. Siga as etapas a seguir para gerar uma chave:

1. Faça login no back-end do Wo­o­Com­merce/WordPress.
2. Clique em “Wo­o­Com­merce” no menu à esquerda da tela.
3. Clique em “Settings”.
4. Navegue até a guia “Advanced”.
5. Clique no subitem “REST API”.
6. Clique em “Add key”.

Close

Você precisará preencher três campos. Em “Des­crip­tion”, adicione um nome para a chave que permita iden­ti­ficá-la fa­cil­mente. Em “User” (Usuário), selecione o usuário do Wo­o­Com­merce para o qual você deseja gerar uma chave. E, fi­nal­mente, em “Per­mis­si­ons”, selecione se o usuário deve ter acesso de Leitura, Gravação ou Leitura/Gravação.

Quando você clicar em “Generate API Key”, o Wo­o­Com­merce criará duas cadeias al­fa­nu­mé­ri­cas (a chave do con­su­mi­dor e o segredo do con­su­mi­dor) e um código QR. Copie as duas chaves e salve-as em um documento. Você precisará delas mais tarde para acessar um cliente REST na API do Wo­o­Com­merce.

Close

Etapa 2: Faça o download do cliente de API

Depois de gerar uma chave, você pode enviar suas so­li­ci­ta­ções para a interface do Wo­o­Com­merce. Para fazer isso, você precisará de um cliente de API para enviar so­li­ci­ta­ções e exibir respostas. Dois clientes populares para acesso REST são Insomnia e Postman. Ambas as fer­ra­men­tas estão dis­po­ní­veis como apli­ca­ti­vos de desktop para Windows, MacOS e Linux. O Postman também está dis­po­ní­vel como um apli­ca­tivo da Web e é o cliente que usaremos neste tutorial.

Para instalar e con­fi­gu­rar o Postman, siga estas etapas:

1. Vá para Página de download do Postman e faça o download da versão do cliente para seu sistema ope­ra­ci­o­nal.
2. Clique duas vezes no arquivo de con­fi­gu­ra­ção para executá-lo.
3. Crie uma conta do Postman. Digite seu endereço de e-mail, escolha um nome de usuário e defina uma senha. Como al­ter­na­tiva, você pode se registrar com uma conta do Google.
4. Preencha o restante do for­mu­lá­rio e, se for o caso, envie links de convite para seus colegas.

Close

Etapa 3: criar so­li­ci­ta­ção de API do Wo­o­Com­merce

Depois de con­fi­gu­rar o Postman, você pode testar seu acesso à API REST enviando sua primeira so­li­ci­ta­ção. Para fazer isso, abra seu espaço de trabalho e clique em “Create new request”.

Close

Como primeiro teste, en­vi­a­re­mos uma so­li­ci­ta­ção GET para consultar dados. Esse tipo de so­li­ci­ta­ção é definido como padrão no Postman, portanto, basta deixar o menu suspenso como está. Na linha de endereço, digite o endereço mostrado abaixo. Substitua “wo­o­com­merce-domain.xyz” pela URL da sua loja Wo­o­Com­merce.

https://woocommerce-domain.xyz/wp-json/wc/v3/orders

Em seguida, adicione seus dados de au­ten­ti­ca­ção. A forma de fazer isso dependerá do fato de você estar usando HTTP ou HTTPS (re­co­men­dado) para acesso REST. Vá para a guia “Autho­ri­za­tion” e, em “Type”, selecione “OAuth 1.0” para HTTP ou “Basic Auth” para HTTPS. Em seguida, insira a chave do con­su­mi­dor e os códigos secretos do con­su­mi­dor men­ci­o­na­dos acima. Se estiver usando “Basic Auth”, use a chave para “Username” (nome de usuário) e o segredo para “Password” (senha).

Close

Depois de inserir essas in­for­ma­ções, clique em “Send” para iniciar a so­li­ci­ta­ção. No exemplo acima, você está so­li­ci­tando todos os pedidos atuais. O Postman exibirá a resposta no painel abaixo. Você pode escolher entre os formatos JSON, XML, HTML ou Texto.

Close