Shopify

Com o conector da Shopify, você pode realizar operações de inserção, exclusão, atualização e leitura.

Versões compatíveis

Esse conector modela as APIs de administrador do Shopify como um banco de dados relacional.

Antes de começar

Antes de usar o conector da Shopify, faça o seguinte:

No seu projeto do Google Cloud, faça o seguinte:
- Conceda o papel do IAM roles/connectors.admin ao usuário que estiver configurando 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:

No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.
Acesse a página "Conexões"
Clique em + CRIAR NOVO para abrir a página Criar conexão.
Na seção Local, escolha o local da conexão.
1. Região: selecione um local na lista suspensa.
  Para acessar a lista de todas as regiões com suporte, consulte Locais.
2. Clique em PRÓXIMA.
Na seção Detalhes da conexão, faça o seguinte:
1. Conector: selecione Shopify 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 exceder 63 caracteres.
4. Como opção, insira uma Descrição para a instância de conexão.
5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
6. 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.
7. ID do app: appId da API Admin.
8. Máximo de pontos por chamada: especifica o custo de cada chamada.
9. Esquema: especifique a versão do servidor Shopify para se conectar.
10. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
11. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
12. Clique em PRÓXIMA.
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.
  1. No campo Endereço do host, especifique o nome do host ou o endereço IP do destino.
    1. Se você quiser estabelecer uma conexão privada com seus sistemas de back-end, siga estas etapas:
      1. Crie um anexo do serviço PSC.
      2. Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
    2. 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.
  Para inserir outros destinos, clique em +ADICIONAR DESTINO.
2. Clique em PRÓXIMA.
Na seção Autenticação, insira os detalhes de autenticação.
1. A conexão da Shopify não requer autenticação.
2. Clique em PRÓXIMA.
Revisão: revise os detalhes de conexão e autenticação.
Clique em Criar.

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:
- List
- Receber
- Criar
- Atualizar
- Excluir
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 da entidade, essas operações 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. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Exemplos de operação de entidade

Exemplo: listar todos os produtos

Neste exemplo, listamos todos os registros na entidade Products.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Products na lista de Entity.
Selecione a operação List e clique em Concluído.

Exemplo: receber detalhes do cliente

Este exemplo recebe os detalhes do cliente especificado da entidade Customers.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Customers na lista de Entity.
Selecione a operação Get e clique em Concluído.
Digite o ID da entidade do cliente cujos detalhes você quer buscar.
Na seção Task Input da tarefa Connectors, clique em entityId e insira 365009521884E12 no campo Valor padrão.

Exemplo: excluir um registro de pedido

Este exemplo exclui a ordem especificada da entidade Order.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Order na lista de Entity.
Selecione a operação Delete e clique em Concluído.
Insira o ID da entidade do pedido que você quer excluir.
Na seção Task Input da tarefa Connectors, clique em entityId e insira 475009571483E15 no campo Valor padrão.

Exemplo: adicionar um cliente

Neste exemplo, o cliente especificado é adicionado à entidade Customer.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Customer na lista de Entity.
Selecione a operação Create e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"FirstName": "Test",
"LastName": "Customer5"
}
```
A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:
```
{
"Id": 6448083206296
}
```

Exemplo: criar um registro em DiscountCode

Neste exemplo, um novo registro é criado na entidade DiscountCode.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione DiscountCode na lista de Entity.
Selecione a operação Create e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"PriceRuleId": 1.394097291568E12,
"Code": "FREESHIP2025798"
}
```
A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:
```
{
"Id": 1.97836790828E13,
"PriceRuleId": null
}
```

Exemplo: criar um registro em Pricerule

Neste exemplo, um novo registro é criado na entidade Pricerule.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Pricerule na lista de Entity.
Selecione a operação Create e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"Id": 7.13459564696E11,
"AllocationMethod": "each",
"CustomerSelection": "all",
"TargetType": "line_item",
"UsageLimit": 100.0,
"Title": "DP_PriceRule"
}
```
A execução desse exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:
```
{
"Id": 197836790834,
"PriceRuleId": null
}
```

Exemplo: criar um registro em ProductVariant

Neste exemplo, um novo registro é criado na entidade ProductVariant.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione ProductVariant na lista de Entity.
Selecione a operação Create e clique em Concluído.

Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

{
"Id": 1070325065,
"ProductId": 7652181016728,
"ImageId": null,
"Price": 1,
"CompareAtPrice": null,
"Title": "Yellow",
"Barcode": null,
"FulfillmentService": "manual",
"InventoryManagement": "shopify",
"InventoryPolicy": "deny",
"InventoryQuantity": 1070325069,
"Option1": "Yellow",
"Option2": null,
"Option3": null,
"Position": 5,
"Sku": "",
"Taxable": true
}

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:

{
"Id": 42711984373912
}

Exemplo: atualizar os detalhes do cliente

Este exemplo atualiza os detalhes do cliente especificado na entidade Customer.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Customer na lista de Entity.
Selecione a operação Update e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"FirstName": "Test",
"LastName": "Customer2"
}
```
Digite o ID da entidade do cliente que você quer excluir.
Na seção Task Input da tarefa Connectors, clique em entityId e insira 648400653532 no campo Valor padrão.

Como alternativa, em vez de especificar o entityId, você também pode definir o filterLesson como 648400653532.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:
```
{
"Id": 648400653532
}
```

Exemplo: atualizar um registro em ProductVariant

Este exemplo atualiza um registro na entidade ProductVariant.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione ProductVariant na lista de Entity.
Selecione a operação Update e clique em Concluído.

Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

{
"ProductId": 7.652181016728E12,
"ImageId": null,
"Price": 200.0,
"CompareAtPrice": null,
"Title": "Yellow Updated",
"Barcode": null,
"FulfillmentService": "manual",
"InventoryManagement": "shopify",
"InventoryQuantity": 1.070325069E9,
"Option1": "Yellow new",
"Option2": null,
"Option3": null,
"Position": 5.0,
"Sku": "",
"Taxable": true
}

Especifique o ID da entidade do registro a ser atualizado.
Para definir o ID da entidade, clique em entityId e insira 34601602744472 no campo Valor padrão.

A execução deste exemplo retorna uma resposta semelhante à seguinte na variável de saída connectorOutputPayload da tarefa do conector:
```
{
"Id": 2484258073471
}
```

Usar o Terraform para criar conexões

Use o recurso do Terraform (em inglês) para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Confira um exemplo de modelo do Terraform para criar uma conexão em exemplo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
max_points_per_call	STRING	Falso	Especifica quantos pontos uma ligação custará.
schema_v23	ENUM	Falso	Especifique a versão do servidor da Shopify para se conectar. Os valores aceitos são: REST-2023-04, REST-2023-07, GRAPHQL-2023-04, GRAPHQL-2023-07.
proxy_enabled	BOOLEAN	Falso	Marque essa caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme	ENUM	Falso	O tipo de autenticação a ser usado para autenticar o proxy ProxyServer. Valores aceitos: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticação no proxy ProxyServer.
proxy_password	SECRET	Falso	Uma senha a ser usada para autenticação no proxy ProxyServer.
proxy_ssltype	ENUM	Falso	O tipo de SSL a ser usado na conexão com o proxy do ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, SELECTED

Usar a conexão da Shopify em uma integração

Depois de criar a conexão, ela ficará disponível tanto na Apigee Integration quanto na Application Integration. Use a conexão em uma integração por meio da tarefa Conectores.

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

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir

Entenda como suspender e retomar uma conexão.
Entenda como monitorar o uso do conector.
Entenda como visualizar os registros do conector.