Ir para o conteúdo

Conexão Shopify

Introdução

Uma conexão Shopify, criada usando o conector Shopify, estabelece acesso ao Shopify. Uma vez que uma conexão é configurada, é possível criar instâncias de atividades Shopify associadas a essa conexão para serem usadas como fontes (para fornecer dados em uma operação) ou como alvos (para consumir dados em uma operação).

Criar ou editar uma conexão Shopify

Uma nova conexão Shopify é criada usando o conector Shopify a partir de uma destas localizações:

Uma conexão Shopify existente pode ser editada a partir destas localizações:

Configurar uma conexão Shopify

Cada elemento da interface do usuário da tela de configuração da conexão Shopify é descrito abaixo.

Configuração da conexão Shopify

Dica

Campos com um ícone de variável suportam o uso de variáveis globais, variáveis de projeto, e variáveis Jitterbit. Comece digitando um colchete aberto [ no campo ou clicando no ícone de variável para exibir uma lista das variáveis existentes para escolher.

  • Nome da conexão: Insira um nome para identificar a conexão. O nome deve ser exclusivo para cada conexão Shopify e não deve conter barras / ou dois-pontos :. Este nome também é usado para identificar o endpoint Shopify, que se refere tanto a uma conexão específica quanto às suas atividades.

  • Nome da loja: Insira o nome da loja Shopify.

  • Tipo de autenticação: Selecione o tipo de autenticação, um de Autenticação básica ou Token de acesso Shopify. Se você estiver usando um aplicativo privado, selecione Autenticação básica. Se você estiver usando um aplicativo personalizado criado no admin do Shopify, selecione Token de acesso Shopify.

  • Chave da API: Se Autenticação básica foi selecionada como o Tipo de autenticação, insira a chave da API para a instância Shopify.

  • Senha: Se Autenticação básica foi selecionada como o Tipo de autenticação, insira a senha para a instância Shopify.

  • Token de acesso da API: Se Token de acesso Shopify foi selecionado como o Tipo de autenticação, insira o token de acesso da API para a instância Shopify.

  • Configurações opcionais: Clique para expandir configurações adicionais:

    • Usar configurações de proxy (Apenas Agente Privado): Ao usar um agente privado, esta configuração pode ser selecionada para usar configurações de proxy do agente privado.

    • Versão da API: Selecione a versão da API REST Admin do Shopify, uma de 2022-04 (padrão), 2023-01, 2023-04, 2023-07, 2023-10, 2024-01, 2024-04, 2024-07, 2024-10, 2025-01, 2025-04 ou 2025-07. Dependendo dos endpoints da API suportados pelo Shopify na versão da API em uso, os objetos e sub-objetos disponíveis para seleção durante a configuração da atividade podem variar. Se você alterar a Versão da API para uma conexão que já possui atividades configuradas, consulte considerações adicionais em Alterar a versão da API abaixo.

      Importante

      Shopify lança uma nova versão da API a cada três meses e mantém cada versão lançada por um mínimo de doze meses. Uma vez que uma versão da API é descontinuada, a Shopify não manterá mais essa versão, e quaisquer chamadas de API solicitando essa versão serão automaticamente direcionadas para a versão estável mais antiga atualmente suportada.

      A Shopify pode descontinuar certos endpoints com a introdução de uma nova versão da API. Como resultado, pode ser necessário alterar suas configurações de aplicativos e atividades devido a recursos alterados ou aposentados.

      Versões e endpoints da API descontinuados são anunciados no changelog da Shopify, onde estão disponíveis mais detalhes e informações relevantes sobre migração.

    • Cabeçalhos de Solicitação: Use esta tabela para adicionar quaisquer pares chave-valor a serem enviados com cada solicitação de atividade. Cada valor adicionado à tabela é incluído no esquema de solicitação de cada atividade.

      • Adicionar: Adiciona uma linha à tabela. Insira um par chave-valor para cada propriedade.
      • Enviar: Salva o par chave-valor na tabela. Visível ao passar o mouse sobre uma linha no modo de edição.
      • Descartar: Descartar uma nova linha ou quaisquer edições feitas em uma linha existente. Visível ao passar o mouse sobre uma linha no modo de edição.
      • Editar: Permite editar um par chave-valor existente. Visível ao passar o mouse sobre uma linha existente.
      • Excluir: Exclui a linha da tabela. Visível ao passar o mouse sobre uma linha existente.
      • Limpar Tudo: Exclui todas as linhas da tabela.

      Importante

      Os campos na tabela Cabeçalhos de Solicitação exibem o ícone de variável apenas no modo de edição. Para que os valores de variável desses campos sejam preenchidos em tempo de execução, a versão do agente deve ser pelo menos 10.75 / 11.13.

Os campos na tabela Request Headers não suportam o uso de variáveis para passar JSON bruto. Se o seu caso de uso não suportar a definição de JSON bruto nos campos diretamente, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapando {"success": "true"}; torna-se {\"success\": \"true\"};.

  • Testar: Clique para verificar a conexão usando a configuração fornecida. Quando a conexão é testada, a versão mais recente do conector é baixada pelo(s) agente(s) no grupo de agentes associado ao ambiente atual. Este conector suporta suspender o download da versão mais recente do conector usando a política de Desativar Atualização Automática do Conector política da organização.

  • Salvar Alterações: Clique para salvar e fechar a configuração da conexão.

  • Descartar Alterações: Após fazer alterações em uma configuração nova ou existente, clique para fechar a configuração sem salvar. Uma mensagem pede que você confirme que deseja descartar as alterações.

  • Excluir: Após abrir uma configuração de conexão existente, clique para excluir permanentemente a conexão do projeto e fechar a configuração (veja Dependências de componentes, exclusão e remoção). Uma mensagem pede que você confirme que deseja excluir a conexão.

Mudar a versão da API

Se uma conexão Shopify tiver atividades configuradas existentes, há considerações adicionais a serem levadas em conta ao mudar a Versão da API selecionada. Isso ocorre porque os objetos e sub-objetos disponíveis para seleção na configuração da atividade dependem dos endpoints da API suportados pelo Shopify na versão da API que está sendo usada. Se a configuração de atividade existente usar endpoints da API que não são suportados na versão da API para a qual você está mudando, essas atividades falharão, a menos que sejam reconfiguradas.

Para evitar que isso ocorra, siga estas etapas:

  1. Mude a versão da API na conexão Shopify.

  2. Abra cada tela de configuração de atividade onde um objeto ou sub-objeto está selecionado e clique em Atualizar. Ao atualizar, as listas de seleção do objeto e sub-objeto atuais serão recuperadas usando a versão da API selecionada na conexão com o Shopify. Observe que o Shopify redireciona automaticamente chamadas de versões de API não suportadas para a próxima versão suportada mais antiga.

    Importante

    Se o objeto ou sub-objeto selecionado não for suportado na versão da API chamada, a seleção pode mudar ao atualizar. Preste atenção para garantir que quaisquer seleções alteradas estejam conforme o esperado.

  3. Selecione o objeto e sub-objeto apropriados suportados pela versão da API chamada.

  4. Reimplantar operações usando a conexão e atividades.

Próximas etapas

Após a criação de uma conexão com o Shopify, você coloca um tipo de atividade na tela de design para criar instâncias de atividade que serão usadas como fontes (para fornecer dados em uma operação) ou como alvos (para consumir dados em uma operação).

As ações do menu para uma conexão e seus tipos de atividade estão acessíveis a partir do painel do projeto e da paleta de componentes de design. Para detalhes, veja Menus de ações em Conceitos básicos do conector.

Estes tipos de atividade estão disponíveis:

  • Ler: Recupera dados de objeto do Shopify e é destinado a ser usado como uma fonte em uma operação.

  • Consultar: Consulta dados de objeto do Shopify e é destinado a ser usado como uma fonte em uma operação.

  • Criar: Cria dados de objeto no Shopify e é destinado a ser usado como um alvo em uma operação.

  • Atualizar: Atualiza dados de objeto no Shopify e é destinado a ser usado como um alvo em uma operação.

  • Excluir: Exclui dados de objeto do Shopify e é destinado a ser usado como um alvo em uma operação.