Zendesk

Il connettore Zendesk consente di eseguire operazioni di inserimento, eliminazione, aggiornamento e lettura sul database Zendesk.

Versioni supportate

Questo connettore supporta le API Versione 2 di Zendesk.

Prima di iniziare

Prima di utilizzare il connettore Zendesk, svolgi i seguenti passaggi:

  • Nel tuo progetto Google Cloud:
    • Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
    • Concedi i seguenti ruoli IAM all'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 autenticarsi ed essere autorizzato ad accedere ai dati nelle API di Google. Se non hai un account di servizio, devi crearne uno. Per saperne di più, consulta la pagina sulla creazione di un account di servizio.

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

      Per informazioni su come abilitare i servizi, vedi Abilitazione dei servizi.

    Se questi servizi o queste autorizzazioni non sono stati abilitati per il tuo progetto in precedenza, ti verrà chiesto di abilitarli durante la configurazione del connettore.

  • Se vuoi utilizzare il tuo indirizzo email e la tua password per accedere all'API Zendesk, attiva password access nel centro di amministrazione di Zendesk. Per ulteriori informazioni, vedi Autenticazione di base.

Configura il connettore

Per configurare il connettore è necessario creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Ciò significa che se disponi di molte origini dati, devi creare una connessione separata per ciascuna. Per creare una connessione, segui questi passaggi:

  1. Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.

    Vai alla pagina Connessioni

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

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

    2. Fai clic su AVANTI.
  4. Nella sezione Dettagli connessione, completa quanto segue:
    1. Connettore: seleziona Zendesk dall'elenco a discesa dei connettori disponibili.
    2. Versione 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 superare i 63 caratteri.
    4. (Facoltativo) Inserisci una descrizione per l'istanza di connessione.
    5. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
    6. Per utilizzare la connessione per le sottoscrizioni agli eventi, seleziona Abilita sottoscrizione agli eventi. Se selezioni questa opzione, vengono visualizzate le seguenti opzioni:
      • Abilita la sottoscrizione agli eventi con entità e azioni: seleziona questa opzione per utilizzare la connessione sia per la sottoscrizione agli eventi sia per le operazioni del connettore (entità e azioni).
      • Abilita solo la sottoscrizione all'evento: seleziona questa opzione per utilizzare la connessione solo per la sottoscrizione all'evento.

      Per entrambe le selezioni, ti verrà chiesto di configurare i dettagli dell'evento nei passaggi successivi.

    7. Facoltativamente, 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, al contrario, sono necessari meno nodi per elaborare un numero minore di transazioni. Per capire in che modo i nodi influiscono sui prezzi del connettore, consulta Prezzi dei nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi è impostato su 2 (per una migliore disponibilità) e il numero massimo di nodi è impostato su 50.

    8. Utilizza proxy: seleziona questa casella di controllo per configurare un server proxy per la connessione e configurare i seguenti valori:
      • Schema di autenticazione proxy: seleziona il tipo di autenticazione per eseguire l'autenticazione con il server proxy. Sono supportati i seguenti tipi di autenticazione:
        • Di base: autenticazione HTTP di base.
        • Digest: autenticazione HTTP di Digest.
      • Utente proxy: un nome utente da utilizzare per l'autenticazione con il server proxy.
      • Proxy Password (Password proxy): il segreto di Secret Manager della password dell'utente.
      • Tipo SSL proxy: il tipo SSL da utilizzare per la connessione al server proxy. Sono supportati i seguenti tipi di autenticazione:
        • Automatica: l'impostazione predefinita. Se l'URL è un URL HTTPS, viene utilizzata l'opzione Tunnel. Se l'URL è un URL HTTP, viene utilizzata l'opzione MAI.
        • 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:

    9. Facoltativamente, fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave-valore.
    10. 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.
      1. Nel campo Indirizzo host, specifica il nome host o l'indirizzo IP della destinazione.
        1. Se vuoi stabilire una connessione privata ai sistemi di backend, segui questi passaggi:
          1. Crea un collegamento al servizio PSC.
          2. Crea un collegamento endpoint e inserisci i relativi dettagli nel campo Indirizzo host.
        2. Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con maggiore sicurezza, puoi configurare indirizzi IP statici in uscita per le tue connessioni, quindi configurare le regole firewall in modo da inserire nella lista consentita solo indirizzi IP statici specifici.

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

    2. Fai clic su AVANTI.
  6. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
    1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.

      La connessione Zendesk supporta i seguenti tipi di autenticazione:

      • Nome utente e password

      2. Per informazioni su come configurare questi tipi di autenticazione, vedi Configurare l'autenticazione.

    2. Fai clic su AVANTI.
  7. Se hai abilitato la sottoscrizione all'evento, nella pagina di creazione della connessione viene visualizzata la sezione Dettagli abbonamento all'evento. Per capire come configurare i dettagli della sottoscrizione agli eventi, consulta Configurare la sottoscrizione agli eventi.
  8. Verifica: controlla i dettagli di connessione e autenticazione.
  9. Fai clic su Crea.

Configura l'autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

  • Nome utente e password
    • Username (Nome utente): il nome utente Zendesk da utilizzare per la connessione.
    • Password: secret di Secret Manager contenente la password associata al nome utente Zendesk.

Configura la sottoscrizione all'evento

Se hai abilitato la sottoscrizione all'evento, inserisci i seguenti valori nella sezione Event Subscription Details (Dettagli abbonamento evento):

  1. Seleziona un Tipo di destinazione.
    • Indirizzo host: inserisci l'URL di registrazione del tuo sistema di backend nel campo host.
  2. Inserisci i dettagli di autenticazione.
    1. Nome utente: inserisci il nome utente.
    2. Password: seleziona il secret di Secret Manager contenente la password associata al nome utente.
    3. Secret Version (Versione secret): seleziona la versione del secret.
  3. Facoltativamente, seleziona Abilita l'arricchimento dei dati se vuoi aggiungere informazioni aggiuntive alla risposta del sistema di backend.

    Le informazioni aggiuntive sono specifiche per l'entità per cui hai configurato l'evento. Per maggiori informazioni, consulta Arricchimento dei dati nelle notifiche degli eventi.

  4. Seleziona Abilita connettività privata per la connettività sicura tra l'applicazione di backend e la connessione. Se selezioni questa opzione, devi eseguire ulteriori passaggi di configurazione dopo aver creato la connessione. Per saperne di più, consulta Connettività privata per la sottoscrizione agli eventi.
  5. Inserisci la configurazione messaggi non recapitabili. Se configuri i messaggi non recapitabili, la connessione scrive gli eventi non elaborati nell'argomento Pub/Sub specificato. Inserisci i seguenti dettagli:
    1. ID progetto messaggi non recapitabili: l'ID progetto Google Cloud in cui hai configurato l'argomento Pub/Sub messaggi non recapitabili.
    2. Argomento messaggi non recapitabili: l'argomento Pub/Sub in cui vuoi scrivere i dettagli dell'evento non elaborato.
  6. Se vuoi utilizzare un proxy per la connessione al tuo backend (per la sottoscrizione agli eventi), inserisci i seguenti dettagli:
    1. Tipo SSL proxy: il tipo SSL da utilizzare per la connessione al server proxy. Seleziona uno dei seguenti tipi di autenticazione:
      • Sempre: la connessione è sempre abilitata per SSL per la sottoscrizione agli eventi.
      • Mai: la connessione non è abilitata per SSL per la sottoscrizione all'evento.
    2. Schema di autenticazione proxy: seleziona il tipo di autenticazione per eseguire l'autenticazione con il server proxy. Sono supportati i seguenti tipi di autenticazione:
      • Di base: autenticazione HTTP di base.
    3. Utente proxy: inserisci il nome utente da utilizzare per l'autenticazione con il server proxy.
    4. Password del proxy: seleziona il secret di Secret Manager della password dell'utente.
    5. Versione del secret: seleziona la versione del secret.
    6. Nella sezione Server proxy, inserisci i dettagli del server proxy.
      1. Fai clic su + Aggiungi destinazione e seleziona Tipo di destinazione come Indirizzo host.
      2. Inserisci il nome host o l'indirizzo IP del server proxy e il numero di porta del server proxy.

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 è esposta come entità, operazioni e azioni.

  • Entità: un'entità può essere considerata come un oggetto o una raccolta di proprietà nell'applicazione o nel servizio collegato. La definizione di un'entità è diversa da un connettore a un connettore. Ad esempio, in un connettore di database, le tabelle sono le entità, in un connettore di file server, le cartelle sono le entità e in un connettore di 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à. Su un'entità puoi eseguire una qualsiasi delle seguenti operazioni:

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

  • Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione attraverso l'interfaccia del connettore. Un'azione consente di apportare modifiche a una o più entità e di variare da connettore a connettore. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Limitazioni di sistema

Il connettore Zendesk può elaborare cinque transazioni al secondo per nodo e limitare qualsiasi transazione oltre questo limite. Per impostazione predefinita, Integration Connectors alloca 2 nodi (per una migliore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, consulta Limiti.

Azioni

Il connettore Zendesk fornisce azioni per gestire i ticket in base a ticket ID. Per capire come configurare le azioni, consulta gli esempi di azioni.

Esempi di azioni

Questa sezione descrive come eseguire alcune delle azioni in questo connettore.

Esempio: eliminare un ticket

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione DeleteTicketsPermanently, quindi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value: 
    {
  "Id": "18"
}

    4. Questo esempio elimina definitivamente il ticket. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

    [{
  "Success": "true"
}]

Esempio - Unisci ticket

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione MergeTickets, quindi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value: 
    {
  "Id": "25",
  "Id": "26"
}

    4. Questo esempio unisce i due ticket. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

    [{
  "Success": null,
  "Message": null
}]

Esempio: ripristinare un ticket

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione RestoreTicket, quindi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value: 
    {
  "id": "20"
}

    4. In questo esempio viene ripristinato un ticket. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

    [{
  "Success": "true"
}]

Esempio: recuperare un ticket sospeso

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione RecoverSuspendedTicket, quindi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e inserisci un valore simile al seguente nel campo Default Value: 
    {
  "id": "18726501985809"
}

    4. Questo esempio recupera il ticket sospeso. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

    [{
  "Id": "60921"
}]

Esempi di operazioni sull'entità

Esempio: elencare tutti i biglietti

In questo esempio sono elencati tutti i ticket nell'entità Tickets.

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

Esempio: ricevi un biglietto

Questo esempio recupera dall'entità Tickets il ticket il cui ID è 35.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Tickets dall'elenco Entity.
  3. Seleziona l'operazione GET, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su EntityId e inserisci 35 nel campo Valore predefinito.

    Qui, 35 è il valore della chiave primaria dell'entità Tickets.

Esempio: creare un ticket

In questo esempio viene creato un ticket nell'entità Tickets.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Tickets 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 inserisci un valore simile al seguente nel campo Default Value: 
    {
    "Subject": "Zendesk_Create_Ticket",
    "Description": "Test",
    "Type": "incident",
    "Priority": "urgent",
    "Status": "open",
    "Recipient": null,
    "HasIncidents": false,
    "DueAt": null,
    "RequesterId": 3.84625885158E11,
    "SubmitterId": 3.84625883418E11,
    "AssigneeId": 3.84625883418E11,
    "OrganizationId": "16665992392721",
    "GroupId": 3.60008282358E11,
    "TicketFormId": 3.60001719218E11,
    "BrandId": 3.60003285058E11
  }

    Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

     {
    "Id": 38.0
  }

Esempio: aggiornamento di un ticket

Questo esempio aggiorna il ticket il cui ID è 35 nell'entità Tickets.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Biglietti 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 inserisci un valore simile al seguente nel campo Default Value: 
    {
      "Subject": "Zendesk_Ticket_Update",
      "Description": "Updating the ticket",
      "RequesterId": 1.6854335860497E13
    }
  5. Fai clic su entityId, quindi inserisci 35 nel campo Default Value (Valore predefinito).

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

    Se l'integrazione ha esito positivo, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

    {
       Id": 35.0
    }

Esempio: eliminare un ticket

Questo esempio elimina il ticket il cui ID è 35 nell'entità Tickets.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Biglietti dall'elenco Entity.
  3. Seleziona l'operazione Delete, quindi fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId, quindi inserisci 35 nel campo Valore predefinito.

Utilizzare Terraform per creare connessioni

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 delle connessioni, guarda il 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
proxy_enabled BOOLEANO False Seleziona questa casella di controllo per configurare un server proxy per la connessione.
proxy_auth_scheme ENUM False Il tipo di autenticazione da utilizzare per eseguire l'autenticazione sul proxy ProxyServer. I valori supportati sono: BASIC, DIGEST, NONE
proxy_user STRING False Un nome utente da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_password SECRET False Una password da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_ssltype ENUM False Il tipo di SSL da utilizzare per la connessione al proxy ProxyServer. I valori supportati sono: AUTO, ALWAYS, NEVER, GCP

Utilizza la connessione Zendesk in un'integrazione

Dopo aver creato la connessione, diventa disponibile sia in Apigee Integration che in Application Integration. Puoi usare 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.

Ricevi assistenza dalla community Google Cloud

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

Passaggi successivi