WooCommerce

Use o conector do WooCommerce para realizar operações de inserção, exclusão, atualização e leitura na plataforma.

Antes de começar

Antes de usar o conector do WooCommerce, siga estas etapas:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceder o papel do IAM roles/connectors.admin ao usuário e configurar o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para conferir a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em PRÓXIMA.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione WooCommerce na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem ter mais de 49 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Se quiser, ative o Cloud Logging. e selecione um nível de registro. Por padrão, o nível de registro é definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    7. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    8. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
      • Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Básico: autenticação HTTP básica.
        • Resumo: autenticação HTTP de resumo.
      • Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
      • Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
      • Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
        • Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
        • Sempre: a conexão será sempre com SSL ativado.
        • Nunca: a conexão não está com SSL ativado.
        • Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
      • Na seção Servidor proxy, insira os detalhes do servidor proxy.
        1. Clique em + Adicionar destino.
        2. Selecione um Tipo de destino.
          • Endereço do host: especifique o nome do host ou o endereço IP do destino.

            Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:

    9. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    10. Clique em PRÓXIMA.
  5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
    1. Tipo de destino: selecione um Tipo de destino.
      • Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
      • Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.

      Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

    2. Clique em PRÓXIMA.
  6. Na seção Autenticação, insira os detalhes da autenticação.

    Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

  7. Depois de especificar os detalhes de autenticação, clique em PRÓXIMA.
  8. Revisão: revise os detalhes de conexão e autenticação.
  9. Clique em Criar.

Configurar a autenticação

Insira os detalhes de autenticação.

  • Chave do cliente: é a chave do cliente atribuída pelo WooCommerce ao criar as credenciais de autenticação.
  • Chave secreta do cliente: contém a chave secreta do cliente associada ao conector.

Limitações do sistema

O conector do Woocommerce pode processar duas transações por segundo, por nó, e limita qualquer transação além desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Usar a conexão do WooCommerce em uma integração

Depois que você cria a conexão, ela fica disponível nos Apigee Integration e Application Integration. Você pode usar a conexão em uma integração pela tarefa Conectores.

  • Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte a Tarefa Conectores.
  • Para entender como criar e usar a tarefa "Conectores" na integração de aplicativos, consulte Tarefa "Conectores".

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

  • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações de entidade, essas operações sem suporte não serão listadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada, . No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Ações

Nesta seção, listamos as ações compatíveis com o conector. Para saber como configurar ações, consulte os Exemplos de ação.

Atualizar ação de locais de zona de frete

Com essa ação, você pode atualizar os locais de uma zona de frete no WooCommerce.

Inserir parâmetros da ação "Atualizar locais da zona de frete"

Nome do parâmetro Tipo de dados Obrigatório Descrição
ZoneId String Sim O ID da zona a ser atualizada.
Locais String Sim Os detalhes do local.

Por exemplo, sobre como configurar a ação Update Shipping Zone Locations, consulte Exemplos de ação.

Exemplos de ação

Esta seção descreve como executar algumas das ações neste conector.

Exemplo: atualizar os locais das zonas de frete

Neste exemplo, atualizar os locais de uma zona de frete.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação Update Shipping Zone Locations e clique em Concluído.
  3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
    "ZoneId": "7",
    "Locations": "[{\"code\":\"BR:SP\",\"type\":\"state\"}]"
  }

    4. Se a ação for bem-sucedida, o Update Shipping Zone Locations resposta da tarefa connectorOutputPayload terá um valor semelhante ao seguinte:

    [ { "code": "BR:SP", "type": "state",
    "_links_collection_href": "https://your-website.com/wp-json/wc/v3/shipping/zones/7/locations", 
    "_links_describes_href": "https://your-website.com/wp-json/wc/v3/shipping/zones/7", 
    "success": "true" } ]

Exemplos de operações de entidade

Exemplo: listar registros de uma entidade

Este exemplo lista os registros de uma entidade Orders.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Orders na lista Entity.
  3. Selecione a operação List e clique em Concluído.
  4. Na seção Entrada de tarefas da tarefa Conectores, é possível definir a filterClause de acordo com sua necessidade.

    Por exemplo, definir a cláusula de filtro como Id='891', lista apenas os registros com o código de ordem 891.

Exemplo: extrair um único registro de uma entidade

Este exemplo busca um registro da entidade Orders.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Orders na lista Entity.
  3. Selecione a operação Get e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em entityId e e insira 891 no campo Valor padrão.

    Aqui, 891 é um identificador exclusivo da entidade de recurso Orders.

Exemplo: excluir um registro de uma entidade

Este exemplo exclui um registro da entidade Orders.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Orders na lista Entity.
  3. Selecione a operação Delete e clique em Concluído.
  4. Na seção Entrada de tarefa da tarefa Conectores, clique em entityId e e insira 891 no campo Valor padrão.

    Como alternativa, se a entidade tiver chaves primárias compostas em vez de especificar o entityId, é possível defina o filterClause. Por exemplo, Id='891'.

Exemplo: criar um registro em uma entidade

Este exemplo cria um registro na entidade Orders.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Orders na lista Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"BillingFirstName": "Alex",
"BillingLastName": "Smith",
"Status":"processing",
"CustomerId": 1,
"ShippingAddress1":"809/2 Downtown, Alaska, United States"
}

    5. Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá a resposta da operação de criação.

    { 
"Id": 1010 
}

Exemplo: atualizar um registro em uma entidade

Este exemplo atualiza um registro na entidade Orders.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Orders na lista Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value: 
    {
"Status": "on-hold"
}
  5. Na seção Entrada da tarefa da tarefa Connectors, clique em entityId e digite 1010 no campo Valor padrão.

    6. Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector vai ter a resposta da operação de atualização.

    {
"Id": 1010
}