Um guia simples para a API WooCommerce

Publicados: 2020-12-28

Não há dúvida de que o WordPress tornou todo o processo de publicação do seu site mais fácil e simples do que na maioria das outras plataformas. Para prova, você pode simplesmente dar uma olhada nas estatísticas surpreendentes sobre o uso do núcleo do WordPress. Além do mais, o WooCommerce fez para o e-commerce o mesmo que o WordPress fez para a publicação na web. Além de ser amigável para iniciantes, ele oferece ferramentas amigáveis ​​para desenvolvedores, como a API WooCommerce para otimizar seu site.

Neste artigo, apresentaremos a API WooCommerce REST e falaremos sobre como ela se relaciona com a própria API do WordPress. Também discutiremos por que você deseja usar essa tecnologia poderosa e como começar.

Vamos começar!

Apresentando a API WooCommerce REST

A API WooCommerce permite implementar funcionalidades personalizadas para seu site em um nível de software. Você pode codificar de uma forma especificamente projetada para integração com o WooCommerce. Dessa forma, você pode criar praticamente qualquer recurso ou funcionalidade se tiver tempo, habilidade e (potencialmente) orçamento.

Para entender como esse recurso-chave funciona, você deve se familiarizar com dois termos:

  • Transferência de estado representacional (REST). Este é um tópico complicado, mas para os fins deste artigo, REST é um tipo de 'serviço da web' que permite acessar elementos específicos de uma página da web.
  • Interface de programação de aplicativo (API). Em contraste com uma interface gráfica de usuário (GUI), este é essencialmente um conjunto de ganchos de código e filtros que permitem trabalhar com pontos de acesso. Geralmente, você os codificará em determinados arquivos baseados em WordPress.

Em outras palavras, REST define o que você pode acessar em seu site por meio de código, e a API fornece as ferramentas para alavancar esse acesso. Juntos, eles permitem que você faça mudanças significativas no funcionamento do seu site.

Como a API WooCommerce se relaciona com a API REST do WordPress

Quando foi introduzida pela primeira vez, a API WooCommerce era uma entidade única. Em outras palavras, ele foi projetado exclusivamente para acessar 'endpoints' do WooCommerce e não afetou nenhum outro elemento do WordPress.

No entanto, uma vez que a API REST do WordPress foi introduzida, os endpoints do WooCommerce foram mesclados para criar um 'go-to' abrangente para acessar o WordPress nos bastidores. Mesmo assim, ainda há documentação para a API WooCommerce. Se você ler a introdução desse documento, a história da API é amplamente delineada.

Para os fins deste artigo, consideraremos a 'API WooCommerce' como a coleção de endpoints específicos para essa plataforma de comércio eletrônico. Obviamente, os endpoints centrais também serão úteis, portanto, mencionaremos alguns deles também. Resumindo, é melhor não se preocupar em separar essas duas APIs - elas são a mesma coisa agora.

Por que você pode querer usar a API WooCommerce

Você já pode ver por que a API REST WooCommerce é uma flecha empolgante e poderosa na aljava da sua loja. Aqui estão apenas alguns dos motivos pelos quais você pode considerar usá-lo:

  • Você tem uma funcionalidade personalizada para implementar. Se você não conseguir encontrar o que precisa por meio de plug-ins, temas ou trechos de código adicionais, criar a funcionalidade sozinho pode ser uma opção.
  • Os clientes podem obter um front end personalizado. Usando os recursos mais amplos da API REST do WordPress, você pode separar o front-end do seu site do back-end. Isso permite que você aproveite o poder do WordPress por baixo do capô, enquanto cria layouts de página e designs usando outro idioma.
  • Sua equipe pode usar back-ends personalizados. Assim como seus clientes podem obter uma experiência de front-end exclusiva, você pode usar várias partes do WooCommerce para criar um painel de back-end personalizado. Você pode incluir quase todas as métricas ou dados que desejar, essencialmente criando sua própria interface de usuário e plataforma analítica.

Quaisquer que sejam seus motivos, a API WooCommerce oferece algumas funcionalidades muito poderosas. Para demonstrar isso melhor, vamos dar uma olhada em alguns detalhes específicos da API e ver onde e como ela pode ser usada em seu site.

O que você pode conseguir usando a API WooCommerce (4 exemplos)

É tentador simplesmente dizer: “Tudo é possível” quando se trata da API WooCommerce. No entanto, vale a pena examinar algumas tarefas comuns que você pode encontrar, junto com alguns casos de uso específicos.

1. Crie, atualize e exclua produtos

Uma vez que os produtos da sua loja são a força vital do seu negócio, a API WooCommerce dedica muitas opções para garantir que você possa gerenciar todos eles. Você pode trabalhar com praticamente qualquer informação coletada no WooCommerce, embora alguns endpoints sejam somente leitura. Existem até APIs separadas para produtos únicos, variações, atributos e seus termos, taxonomias, classes de envio e avaliações.

Isso pode ser útil de várias maneiras. Por exemplo, considere um site de mercado, onde os usuários carregam seus próprios produtos. Você pode criar um uploader front-end para ajudar a realizar as tarefas administrativas necessárias com base nas entradas do usuário. Você também pode editar em lote muitas análises de produtos relacionados com base na solicitação de um usuário, remover e-mails de identificação e muito mais.

2. Processar pedidos e suas notas associadas

Se os produtos são a força vital de sua loja, os pedidos são o combustível do foguete. Como tal, a API WooCommerce oferece muito para ajudá-lo a administrar pedidos e notas. Praticamente todas as propriedades encontradas no WooCommerce podem ser acessadas, junto com as propriedades relacionadas de faturamento, envio e metadados.

Nós argumentaríamos que a maioria dos usos para este terminal será para listar pedidos de alguma forma. Até mesmo um trecho de uma linha simples oferece um poder imenso. Por exemplo, uma lista pode ser analisada para várias menções do mesmo produto, computada para os pedidos em que uma cesta múltipla continha um item específico e muito mais.

A atualização em lote das notas do pedido é outro uso útil para esse aspecto da API. Pegar uma coleção de pedidos de Natal, dividi-los com base no status de cada um e organizar o JSON resultante em uma planilha pode ajudar a entregar os pedidos com mais rapidez e eficiência.

3. Ajustar taxas e classes de impostos

Os impostos são uma dor de cabeça para muitos proprietários de lojas, especialmente quando você está lidando com pedidos internacionais. Como existem muitas maneiras diferentes de aplicar impostos em várias taxas, a API WooCommerce oferece várias opções para trabalhar com esses dados. Os endpoints são divididos em duas variantes:

  • Taxas de imposto: é onde a porcentagem real é registrada, junto com alguns outros dados de identificação.
  • Classes de impostos: são amplas faixas de impostos aos quais as taxas são aplicadas.

Por exemplo, você pode criar uma taxa de imposto de 20% aplicada à classe 'Taxa padrão'. Na verdade, ser capaz de atualizar as taxas de imposto em lote é um bom uso da API WooCommerce. Um exemplo mais exclusivo seria uma configuração em que uma taxa ou classe de imposto é criada com base em um atributo específico do cliente. Isso é ideal para situações em que você precisa 'qualificar' um cliente antes de registrá-lo ou enviá-lo para o processo de checkout.

4. Definir zonas de envio, localizações e métodos

Se você já tentou trabalhar com frete no WooCommerce, você entenderá como ele pode ser um campo minado. Se você errar algum elemento, o cliente será impactado diretamente em uma área que está pronta para comentários e avaliações ruins. Felizmente, a API WooCommerce pode funcionar com todos os endpoints associados à remessa, como zonas, locais e métodos.

Quando comparado a outros aspectos da API, não há muitos atributos com os quais trabalhar aqui. No entanto, ainda existem muitas opções disponíveis para ajudá-lo a trabalhar com os dados da sua loja. Embora muitas vezes você queira 'definir e esquecer' as informações de envio (devido à sua complexidade e impacto na experiência do usuário), ainda existem algumas aplicações práticas.

Por exemplo, você provavelmente estará atento às regulamentações atuais do COVID-19 em nível estadual e nacional. Com isso em mente, você pode considerar o uso de uma combinação de terminais para restringir o envio a determinados locais temporariamente. Além disso, você pode notificar os usuários sobre quaisquer atrasos no momento da compra. Isso pode acontecer na tela de checkout ou por meio de comunicação em massa.

Como começar a usar a API WooCommerce

A API WooCommerce REST funciona por meio de um sistema digital baseado em chave para conceder acesso e permissões. Este processo de autenticação tem duas etapas distintas:

  • O WooCommerce cria duas chaves: uma chave do consumidor e uma chave secreta . Eles são feitos de cadeias de caracteres aleatórias e são praticamente impossíveis de decifrar.
  • Sempre que quiser fazer uma 'chamada' para a API REST, você terá que fornecer essas chaves como prova de autenticação.

Este processo é direto, mas obter essas chaves (e usar a própria API) requer que você vá para o painel do WooCommerce - especificamente para a tela WooCommerce> Configurações> Avançado . Procure o link da API REST na parte superior, navegue até essa tela e clique no botão Criar uma chave de API :

Clicar no botão Criar uma chave de API.

Em seguida, preencha o campo Descrição , deixando os outros como estão por enquanto. Deve ser uma descrição simples de para que serve o acesso:

Criando uma nova chave e inserindo os detalhes.

Por fim, selecione o botão Gerar uma chave de API e espere que o WordPress faça seu trabalho. Você verá uma chave do consumidor e uma chave secreta aqui, um código QR para autenticação adicional e um link para revogar o acesso à API no futuro. É importante copiar as chaves agora, pois você não poderá recuperá-las mais tarde.

Neste ponto, você está pronto para começar a codificar. Se isso for algo novo para você, contratar um desenvolvedor para ajudá-lo é uma boa ideia. No entanto, se você quiser mergulhar de cabeça, pode usar um 'cliente de API', como Postman ou Insomnia, para fazer grande parte do trabalho pesado:

A ferramenta Postman.

Para uma visão do mundo real sobre como usar a API WooCommerce, você pode verificar os blogs de desenvolvedores sobre o assunto. Por exemplo, James Kemp da IconicWP oferece insights úteis sobre como um aplicativo da web em PHP e um punhado de código podem se conectar a uma loja de comércio eletrônico e processar seus dados.

Conclusão

Quando se trata de escolher uma plataforma amigável para usuários e desenvolvedores, o WordPress é indiscutivelmente o número um. Além disso, o WooCommerce é igualmente amigável para os proprietários de lojas que desejam simplicidade, potência e flexibilidade. Parte do que o torna tão adaptável é a API WooCommerce REST. Embora já tenha sido uma entidade separada, agora foi incorporada à API REST do WordPress principal.

Este artigo analisou a API WooCommerce e mostrou um vislumbre do que você pode fazer com ela. Você vai querer ter uma compreensão firme dos principais conceitos envolvidos ou pode considerar a contratação de um desenvolvedor para implementar os recursos que deseja. De qualquer forma, o poder que esta API oferece pode ter um impacto direto e positivo em sua loja e receita.

Você está pensando em usar a API WooCommerce para sua loja e, em caso afirmativo, o que mais o entusiasma nisso? Deixe-nos saber na seção de comentários abaixo!

Crédito da imagem em destaque: monkographic / shutterstock.com