Shopify

Il connettore Shopify ti consente di eseguire operazioni di inserimento, eliminazione, aggiornamento e lettura su Shopify.

Versioni supportate

Questo connettore modella le API Shopify Admin come un database relazionale.

Prima di iniziare

Prima di utilizzare il connettore Shopify, esegui le seguenti operazioni:

  • Nel tuo progetto Google Cloud:
    • Assicurati che la connettività di rete sia configurata. Per informazioni sui pattern di rete, consulta Connettività di rete.
    • Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
    • Concedi i seguenti ruoli IAM al account di servizio che vuoi utilizzare per il connettore:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un account di servizio è un tipo speciale di Account Google destinato a rappresentare un utente non umano che deve eseguire l'autenticazione ed essere autorizzato ad accedere ai dati nelle API di Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, vedi Creare un service account.

    • Attiva i seguenti servizi:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Per capire come abilitare i servizi, consulta Abilitazione dei servizi.

    Se questi servizi o queste autorizzazioni non sono stati attivati in precedenza per il tuo progetto, ti viene chiesto di attivarli durante la configurazione del connettore.

Configura il connettore

Una connessione è specifica per un'origine dati. Ciò significa che se hai molte origini dati, devi creare una connessione separata per ciascuna origine dati. Per creare una connessione:

  1. Nella console Cloud, vai alla pagina Integration Connectors > Connessioni e poi seleziona o crea un progetto Google Cloud.

    Vai alla pagina Connessioni

  2. Fai clic su + CREA NUOVA per aprire la pagina Crea connessione.
  3. Nella sezione Località, scegli la località per la connessione.
    1. Regione: seleziona una località dall'elenco a discesa.

      Per l'elenco di tutte le regioni supportate, consulta Località.

    2. Fai clic su AVANTI.
  4. Nella sezione Dettagli connessione, completa quanto segue:
    1. Connettore: seleziona Shopify dall'elenco a discesa dei connettori disponibili.
    2. Versione del connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
    3. Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.

      I nomi delle connessioni devono soddisfare i seguenti criteri:

      • I nomi delle connessioni possono contenere lettere, numeri o trattini.
      • Le lettere devono essere minuscole.
      • I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
      • I nomi delle connessioni non possono contenere più di 49 caratteri.
    4. (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
    5. (Facoltativo) Abilita Cloud Logging, quindi seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su Error.
    6. Service Account: seleziona un account di servizio con i ruoli richiesti.
    7. (Facoltativo) Configura le impostazioni del nodo di connessione:

      • Numero minimo di nodi: inserisci il numero minimo di nodi di connessione.
      • Numero massimo di nodi: inserisci il numero massimo di nodi di connessione.

      Un nodo è un'unità (o una replica) di una connessione che elabora le transazioni. Sono necessari più nodi per elaborare più transazioni per una connessione e, viceversa, sono necessari meno nodi per elaborare meno transazioni. Per capire in che modo i nodi influiscono sui prezzi dei connettori, consulta la sezione Prezzi dei nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita i nodi minimi sono impostati su 2 (per una migliore disponibilità) e i nodi massimi su 50.

    8. Punti massimi per chiamata: specifica il numero di punti che costerà una chiamata.
    9. Schema: specifica la versione del server Shopify a cui connettersi.
    10. (Facoltativo) Nella sezione Impostazioni avanzate, seleziona la casella di controllo Usa proxy per configurare un server proxy per la connessione e configura i seguenti valori:
      • Proxy Auth Scheme: seleziona il tipo di autenticazione per l'autenticazione con il server proxy. Sono supportati i seguenti tipi di autenticazione:
        • Basic: autenticazione HTTP di base.
        • Digest: autenticazione HTTP Digest.
      • Utente proxy: un nome utente da utilizzare per l'autenticazione con il server proxy.
      • Password proxy: il secret di Secret Manager della password dell'utente.
      • Tipo di SSL proxy: il tipo di SSL da utilizzare per la connessione al server proxy. Sono supportati i seguenti tipi di autenticazione:
        • Automatica: impostazione predefinita. Se l'URL è un URL HTTPS, viene utilizzata l'opzione Tunnel. Se l'URL è un URL HTTP, viene utilizzata l'opzione NEVER.
        • Sempre: la connessione è sempre abilitata per SSL.
        • Mai: la connessione non è abilitata per SSL.
        • Tunnel: la connessione avviene tramite un proxy di tunneling. Il server proxy apre una connessione all'host remoto e il traffico scorre avanti e indietro attraverso il proxy.
      • Nella sezione Server proxy, inserisci i dettagli del server proxy.
        1. Fai clic su + Aggiungi destinazione.
        2. Seleziona un tipo di destinazione.
          • Indirizzo host: specifica il nome host o l'indirizzo IP della destinazione.

            Se vuoi stabilire una connessione privata al tuo sistema di backend:

    11. (Facoltativo) Fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
    12. Fai clic su AVANTI.
  5. Nella sezione Destinazioni, inserisci i dettagli dell'host remoto (sistema di backend) a cui vuoi connetterti.
    1. Tipo di destinazione: seleziona un Tipo di destinazione.
      • Per specificare il nome host o l'indirizzo IP di destinazione, seleziona Indirizzo host e inserisci l'indirizzo nel campo Host 1.
      • Per stabilire una connessione privata, seleziona Collegamento endpoint e scegli il collegamento richiesto dall'elenco Collegamento endpoint.

      Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con maggiore sicurezza, puoi valutare la possibilità di configurare indirizzi IP statici in uscita per le tue connessioni e poi configurare le regole del firewall in modo da consentire solo gli indirizzi IP statici specifici.

      Per inserire altre destinazioni, fai clic su +AGGIUNGI DESTINAZIONE.

    2. Fai clic su AVANTI.
  6. Nella sezione Autenticazione, specifica i dettagli del token di accesso.
  7. Fai clic su AVANTI.
  8. Rivedi: rivedi i dettagli di connessione e autenticazione.
  9. Fai clic su Crea.

Crea il token di accesso e le credenziali API

  1. Accedi all'account Shopify.
  2. Nel portale per sviluppatori Shopify, fai clic su Impostazioni.
  3. Seleziona App e canali di vendita > Sviluppa app.
  4. Fai clic su Crea un'app.
  5. Nella finestra di dialogo visualizzata, inserisci il nome dell'app e fai clic su Crea.
  6. Nella pagina Panoramica, fai clic su Configura ambiti API Admin e seleziona le autorizzazioni di accesso per la tua app.
  7. Fai clic su Salva.
  8. Nella pagina Credenziali API, seleziona Installa app.
  9. Nella finestra di dialogo visualizzata, fai clic su Installa.
  10. Nella pagina Credenziali API, seleziona Mostra token una volta e copia Token di accesso amministratore API per utilizzarlo in un secondo momento quando configuri l'autenticazione per la connessione.
  11. Dai campi Chiave API e Chiave segreta API, copia le chiavi per utilizzarle in un secondo momento quando configuri l'autenticazione per la connessione.

Entità, operazioni e azioni

Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti viene mostrata come entità, operazioni e azioni.

  • Entità : un'entità può essere considerata un oggetto o una raccolta di proprietà nell'applicazione o nel servizio connesso. La definizione di un'entità varia da un connettore all'altro. Ad esempio, in un connettore di database, le tabelle sono le entità, in un connettore del file server, le cartelle sono le entità e in un connettore del sistema di messaggistica, le code sono le entità.

    Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.

  • Operazione : un'operazione è l'attività che puoi eseguire su un'entità. Puoi eseguire una delle seguenti operazioni su un'entità:

    Selezionando un'entità dall'elenco disponibile, viene generato un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta alcuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.

  • Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e varia da connettore a connettore. In genere, un'azione ha alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Esempi di operazioni sulle entità

Esempio: elenca tutti i prodotti

Questo esempio elenca tutti i record nell'entità Products.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Products dall'elenco Entity.
  3. Seleziona l'operazione List, quindi fai clic su Fine.

Esempio: recuperare i dettagli del cliente

Questo esempio recupera i dettagli del cliente specificato dall'entità Customers.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Customers dall'elenco Entity.
  3. Seleziona l'operazione Get, quindi fai clic su Fine.
  4. Inserisci l'ID entità del cliente di cui vuoi recuperare i dettagli.

    Nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 365009521884E12 nel campo Valore predefinito.

Esempio: elimina un record di ordine

Questo esempio elimina l'ordine specificato dall'entità Order.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Order dall'elenco Entity.
  3. Seleziona l'operazione Delete, quindi fai clic su Fine.
  4. Inserisci l'ID entità dell'ordine che vuoi eliminare.

    Nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 475009571483E15 nel campo Valore predefinito.

Esempio: aggiungi un cliente

Questo esempio aggiunge il cliente specificato all'entità Customer.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Customer dall'elenco Entity.
  3. Seleziona l'operazione Create, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value: 
    {
"FirstName": "Test",
"LastName": "Customer5"
}

    L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività del connettore:

    {
"Id": 6448083206296
}

Esempio: crea un record in DiscountCode

Questo esempio crea un nuovo record nell'entità DiscountCode.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona DiscountCode dall'elenco Entity.
  3. Seleziona l'operazione Create, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value: 
    {
"PriceRuleId": 1.394097291568E12,
"Code": "FREESHIP2025798"
}

    L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività del connettore:

    {
"Id": 1.97836790828E13,
"PriceRuleId": null
}

Esempio: crea un record in Pricerule

Questo esempio crea un nuovo record nell'entità Pricerule.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Pricerule dall'elenco Entity.
  3. Seleziona l'operazione Create, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value: 
    {
"Id": 7.13459564696E11,
"AllocationMethod": "each",
"CustomerSelection": "all",
"TargetType": "line_item",
"UsageLimit": 100.0,
"Title": "DP_PriceRule"
}

    L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività del connettore:

    {
"Id": 197836790834,
"PriceRuleId": null
}

Esempio: crea un record in ProductVariant

Questo esempio crea un nuovo record nell'entità ProductVariant.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona ProductVariant dall'elenco Entity.
  3. Seleziona l'operazione Create, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel 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
}

    L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività del connettore:

    {
"Id": 42711984373912
}

Esempio: aggiornare i dettagli del cliente

Questo esempio aggiorna i dettagli del cliente specificato nell'entità Customer.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Customer dall'elenco Entity.
  3. Seleziona l'operazione Update, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value: 
    {
"FirstName": "Test",
"LastName": "Customer2"
}
  5. Inserisci l'ID entità del cliente che vuoi eliminare.

    Nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 648400653532 nel campo Valore predefinito.

    In alternativa, anziché specificare entityId, puoi anche impostare filterClause su 648400653532.

    L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività del connettore:

    {
"Id": 648400653532
}

Esempio: aggiornare un record in ProductVariant

Questo esempio aggiorna un record nell'entità ProductVariant.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona ProductVariant dall'elenco Entity.
  3. Seleziona l'operazione Update, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel 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
}
  5. Specifica l'ID entità del record da aggiornare.

    Per impostare l'ID entità, fai clic su entityId e poi inserisci 34601602744472 nel campo Valore predefinito.

    L'esecuzione di questo esempio restituisce una risposta simile alla seguente nella variabile di output connectorOutputPayload dell'attività del connettore:

    {
"Id": 2484258073471
}

Creare connessioni utilizzando Terraform

Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione della connessione, consulta Modello di esempio.

Quando crei questa connessione utilizzando Terraform, devi impostare le seguenti variabili nel file di configurazione Terraform:

Nome parametro Tipo di dati Obbligatorio Descrizione
max_points_per_call STRING Falso Specifica il numero di punti che costerà una chiamata.
schema_v23 ENUM Falso Specifica la versione del server Shopify a cui connetterti. I valori supportati sono: REST-2023-04, REST-2023-07, GRAPHQL-2023-04, GRAPHQL-2023-07
proxy_enabled BOOLEANO Falso Seleziona questa casella di controllo per configurare un server proxy per la connessione.
proxy_auth_scheme ENUM Falso Il tipo di autenticazione da utilizzare per l'autenticazione al proxy ProxyServer. I valori supportati sono: BASIC, DIGEST, NONE
proxy_user STRING Falso Un nome utente da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_password SECRET Falso Una password da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_ssltype ENUM Falso Il tipo di SSL da utilizzare per la connessione al proxy ProxyServer. I valori supportati sono: AUTO, ALWAYS, NEVER, TUNNEL

Utilizzare la connessione Shopify in un'integrazione

Una volta creata la connessione, questa diventa disponibile sia in Apigee Integration che in Application Integration. Puoi utilizzare la connessione in un'integrazione tramite l'attività Connettori.

  • Per capire come creare e utilizzare l'attività Connettori in Apigee Integration, consulta Attività Connettori.
  • Per capire come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Ricevere assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore nella community di Google Cloud nei forum di Cloud.

Passaggi successivi