Conexão Shopify no Jitterbit Studio

Introdução

Uma conexão Shopify, criada usando o conector Shopify, estabelece acesso ao Shopify. Após configurar uma conexão, você pode criar instâncias de atividades Shopify associadas a essa conexão para serem usadas como origens (para fornecer dados em uma operação) ou como destinos (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 um destes locais:

• A guia Project endpoints and connectors (Endpoints e conectores do projeto) da paleta do componente de design (consulte Design component palette).
• A página Global Endpoints (Endpoints globais) (consulte Create a global endpoint em Global Endpoints).

Uma conexão Shopify existente pode ser editada a partir destes locais:

• A guia Project endpoints and connectors (Endpoints e conectores do projeto) da paleta do componente de design (consulte Design component palette).
• A guia Components (Componentes) do painel do projeto (consulte Component actions menu em Project pane Components tab).
• A página Global Endpoints (Endpoints globais) (consulte Edit a global endpoint em Global Endpoints).

Configurar uma conexão Shopify

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

A interface usada na configuração da conexão Shopify depende da opção Authentication mechanism (Mecanismo de autenticação) selecionada:

• Credential-based Auth: Para esta opção, a conexão é autenticada usando credenciais de API da sua loja Shopify.

• OAuth: Para esta opção, a conexão é autenticada através do Shopify em uma guia separada do navegador (3-legged OAuth). Esta opção requer o uso da versão do Agent 10.83 / 11.21 ou posterior.

Credential-based Auth

Quando Credential-based Auth é selecionado como o Authentication mechanism (Mecanismo de autenticação), a interface descrita abaixo é apresentada.

• Connection name: Digite um nome para identificar a conexão. O nome deve ser único 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 a uma conexão específica e suas atividades.

• Store name: Digite o nome da loja Shopify.

• Authentication mechanism: Selecione Credential-based Auth para autenticar usando credenciais de API.

• Authentication type: Selecione o tipo de autenticação, um de Basic authentication (Autenticação básica) ou Shopify access token (Token de acesso Shopify). Se você estiver usando um aplicativo privado, selecione Basic authentication (Autenticação básica). Se você estiver usando um aplicativo personalizado criado no administrador Shopify, selecione Shopify access token (Token de acesso Shopify).

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

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

  • Token de acesso à API: Se Token de acesso do Shopify foi selecionado como o Tipo de autenticação, insira o token de acesso à API para a instância do 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, 2025-07, 2025-10, 2026-04 ou 2026-07. Dependendo dos endpoints de API suportados pelo Shopify na versão de API sendo usada, os objetos e sub-objetos disponíveis para seleção durante a configuração da atividade podem variar. Se alterar a Versão da API para uma conexão que possui atividades já configuradas, consulte considerações adicionais em Alterar a versão da API abaixo.

    Importante

    O Shopify lança uma nova versão de API a cada três meses e mantém cada versão lançada por um mínimo de doze meses. Após uma versão de API ser descontinuada, o Shopify não manterá mais essa versão, e qualquer chamada de API solicitando essa versão será automaticamente roteada para a versão estável mais antiga atualmente suportada.

    O Shopify pode descontinuar certos endpoints com a introdução de uma nova versão de API. Como resultado, você pode precisar alterar seus aplicativos e configurações de atividade devido a recursos alterados ou descontinuados.

    Versões e endpoints de API descontinuados são anunciados no changelog do Shopify, onde qualquer detalhe adicional e informações de migração relevantes estão disponíveis.

  • Cabeçalhos de solicitação: Use esta tabela para adicionar pares de 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 de chave-valor para cada propriedade.
    • Enviar: Salva o par de chave-valor na tabela. Visível ao passar o mouse sobre uma linha em modo de edição.
    • Descartar: Descarta uma nova linha ou qualquer edição feita em uma linha existente. Visível ao passar o mouse sobre uma linha em modo de edição.
    • Editar: Permite editar um par de 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

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

    Campos na tabela Cabeçalhos de solicitação não suportam o uso de variáveis para passar JSON bruto. Se seu caso de uso não suportar a definição de JSON bruto diretamente nos campos, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapar {"success": "true"}; se torna {\"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 organizacional Desabilitar atualização automática do conector.

• Salvar: Clique para salvar e fechar a configuração de 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 solicita que você confirme se 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 (consulte Dependências de componentes, exclusão e remoção). Uma mensagem solicita que você confirme se deseja excluir a conexão.

OAuth

Quando OAuth é selecionado como o Mecanismo de autenticação, a interface descrita abaixo é apresentada. Para notas importantes sobre o comportamento do token de acesso e token de atualização, consulte Notas importantes.

• Nome da conexão: Digite um nome para identificar a conexão. O nome deve ser único 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: Digite o nome da loja Shopify. Este é o valor {shop} usado nas URLs OAuth configuradas em Pré-requisitos.

• Mecanismo de autenticação: Selecione OAuth para autenticar através do Shopify em uma aba separada do navegador (OAuth de 3 etapas). Esta opção requer o uso da versão do agente 10.83 / 11.21 ou posterior.

• Aplicativo OAuth: Use o menu para selecionar um aplicativo OAuth 2.0 em Aplicativos Privados. Esta categoria exibe aplicativos do conector Shopify configurados na página Registros de Aplicativos do Console de Gerenciamento. Para mais informações sobre como configurar um aplicativo do conector Shopify na página Registros de Aplicativos, consulte Pré-requisitos.

• Fazer login com Shopify: Clique para autenticar através do Shopify em uma aba separada do navegador e forneça consentimento para que o Jitterbit acesse a loja 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, 2025-07, 2025-10, 2026-04 ou 2026-07. Dependendo dos endpoints da API suportados pelo Shopify na versão da API sendo usada, os objetos e sub-objetos disponíveis para seleção durante a configuração de atividades podem variar. Se alterar a Versão da API para uma conexão que possui atividades já configuradas, consulte considerações adicionais em Alterar a versão da API abaixo.

    Importante

    O Shopify lança uma nova versão da API a cada três meses e mantém cada versão de lançamento por um mínimo de doze meses. Após uma versão da API ser descontinuada, o Shopify não manterá mais essa versão, e qualquer chamada de API solicitando essa versão será automaticamente roteada 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 de API. Como resultado, você pode precisar alterar suas apps e configurações de atividade devido a recursos alterados ou descontinuados.

As versões de API e endpoints descontinuados são anunciados no changelog da Shopify, onde qualquer detalhe adicional e informações de migração relevantes estão disponíveis.

• Cabeçalhos de Solicitação: Use esta tabela para adicionar pares de 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. Digite um par de chave-valor para cada propriedade.
  • Enviar: Salva o par de chave-valor na tabela. Visível ao passar o mouse sobre uma linha no modo de edição.
  • Descartar: Descarta uma nova linha ou qualquer edição feita em uma linha existente. Visível ao passar o mouse sobre uma linha no modo de edição.
  • Editar: Permite editar um par de 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 Cabeçalhos de Solicitação não suportam o uso de variáveis para passar JSON bruto. Se seu caso de uso não suportar a definição de JSON bruto diretamente nos campos, escape o conteúdo JSON antes de passá-lo com uma variável. Por exemplo, escapar {"success": "true"}; se torna {\"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 organizacional Desabilitar Atualização Automática de Conector.

• Salvar: Clique para salvar e fechar a configuração de 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 solicita 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 (consulte Dependências de componentes, exclusão e remoção). Uma mensagem solicita que você confirme que deseja excluir a conexão.

Alterar a versão de API

Se uma conexão Shopify tiver atividades configuradas existentes, há considerações adicionais a levar em conta ao alterar a Versão de API selecionada. Isso ocorre porque os objetos e sub-objetos disponíveis para seleção na configuração de atividade dependem dos endpoints de API suportados pela Shopify na versão de API sendo usada. Se a configuração de atividade existente usar endpoints de API não suportados na versão de 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. Altere a Versão de 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 de objeto e sub-objeto atuais serão recuperadas usando a versão de API selecionada na conexão Shopify. Observe que a Shopify redireciona automaticamente chamadas de versões de API não suportadas para a versão suportada mais antiga.

   Importante

   Se o objeto ou sub-objeto selecionado não for suportado na versão da API sendo chamada, a seleção pode mudar ao atualizar. Preste atenção para garantir que qualquer seleção alterada seja conforme pretendido.

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

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

Próximas etapas

Após criar uma conexão Shopify, coloque um tipo de atividade na tela de design para criar instâncias de atividade a serem usadas como fontes (para fornecer dados em uma operação) ou como destinos (para consumir dados em uma operação).

As ações de menu para uma conexão e seus tipos de atividade são acessíveis no painel do projeto e na paleta de componentes de design. Para detalhes, consulte Menus de ações em Noções básicas do conector.

Estes tipos de atividade estão disponíveis:

• Ler: Recupera dados de objetos do Shopify e destina-se a ser usado como fonte em uma operação.

• Consultar: Consulta dados de objetos do Shopify e destina-se a ser usado como fonte em uma operação.

• Criar: Cria dados de objetos no Shopify e destina-se a ser usado como destino em uma operação.

• Atualizar: Atualiza dados de objetos no Shopify e destina-se a ser usado como destino em uma operação.

• Excluir: Exclui dados de objetos do Shopify e destina-se a ser usado como destino em uma operação.