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, esegui le seguenti attività:

• Nel tuo progetto Google Cloud:
  • Concedi il ruolo IAM roles/connectors.admin all'utente. configurazione del 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 una persona non umana utente che deve autenticarsi e avere l'autorizzazione ad accedere ai dati nelle API di Google. Se non hai un account di servizio, devi crearne uno. Per ulteriori informazioni le informazioni, vedi Creazione di un account di servizio.

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

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

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

• Se vuoi utilizzare il tuo indirizzo email e la tua password per accedere all'API Zendesk, abilita 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 al tuo origine dati (sistema di backend). Una connessione è specifica per un'origine dati. it significa che se hai molte origini dati, devi creare una connessione separata per ogni origine dati. Per creare una connessione:

1. Nella console Cloud, vai a Connettori di integrazione > Pagina Connessioni e poi selezionare o creare 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 aree geografiche supportate, consulta la sezione Località.

   2. Fai clic su AVANTI.
4. Nella sezione Dettagli connessione, completa i seguenti passaggi:
   .
   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 contenere più di 63 caratteri.
   4. Facoltativamente, 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 iscrizioni agli eventi, seleziona Attiva la sottoscrizione agli eventi. Selezione 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).
      • Attiva solo la sottoscrizione all'evento: seleziona questa opzione per utilizzare la connessione. solo per la sottoscrizione all'evento. Se selezioni questa opzione, fai clic su Avanti e poi configurare la sottoscrizione agli eventi.
   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, per elaborare meno transazioni. Per comprendere in che modo i nodi influiscono sui prezzi dei connettori, consulta Prezzi per i 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.

   Nota: puoi personalizzare i valori del nodo di connessione solo se un cliente con pagamento a consumo.
   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 l'autenticazione con il server proxy. Sono supportati i seguenti tipi di autenticazione:
     • Di base: 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 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 è HTTPS, viene utilizzata l'opzione Tunnel. Se l'URL è HTTP, viene utilizzata l'opzione MAI.
     • Sempre: la connessione è sempre SSL abilitata.
     • Mai: la connessione non è abilitata per SSL.
     • Tunnel: la connessione avviene attraverso un proxy di tunneling. Il server proxy apre una connessione con l'host remoto e il traffico passa 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, segui questi passaggi:

          • Crea un collegamento al servizio PSC.
          • Crea un allegato endpoint e quindi inserisci i dettagli del collegamento dell'endpoint nel campo Indirizzo host.
   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.
      • Seleziona Indirizzo host dall'elenco per specificare il nome host o l'indirizzo IP della destinazione.
      • Se vuoi stabilire una connessione privata ai tuoi sistemi di backend, seleziona Collegamento endpoint dall'elenco, quindi seleziona il collegamento dell'endpoint richiesto. dall'elenco Allegato endpoint.
        Nota: per capire come creare un collegamento dell'endpoint, vedi Collegamento servizio PSC e l'allegato endpoint. Dopo hanno creato il collegamento dell'endpoint, sarà visibile nell'elenco Allegato endpoint.

      Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con maggiore sicurezza, puoi valuta la possibilità di configurare una rete statico in uscita indirizzi IP per le tue connessioni, quindi configura le regole del firewall per inserire nella lista consentita solo gli 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

   Per informazioni su come configurare questi tipi di autenticazione, consulta l'articolo Configurare l'autenticazione.

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

Configura l'autenticazione

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

• Nome utente e password .
  .
  • 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 agli eventi

Se hai attivato la sottoscrizione all'evento, inserisci i seguenti valori nella sezione Dettagli sottoscrizione all'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. Versione secret: seleziona la versione del secret.
3. Facoltativamente, seleziona Abilita l'arricchimento dei dati se vuoi informazioni aggiuntive da aggiungere alla risposta del sistema di backend.

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

   Nota: se hai configurato questa connessione solo per la sottoscrizione agli eventi, non puoi abilitare questa opzione. Per abilitare l'arricchimento dei dati, devi configurare la connessione per sia la sottoscrizione agli eventi sia le operazioni del connettore (entità e azioni).
4. Seleziona Abilita connettività privata per una connettività sicura tra la tua applicazione di backend e la connessione. Se selezioni questa opzione, devi eseguire passaggi di configurazione aggiuntivi dopo aver creato la connessione. Per ulteriori informazioni, consulta la sezione Connettività privata per l'abbonamento agli eventi.
5. Inserisci la configurazione dei 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 connetterti al 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 un'opzione dei seguenti tipi di autenticazione:
   • Sempre: la connessione è sempre SSL abilitata per l'iscrizione all'evento.
   • Mai: la connessione non è abilitata per SSL per la sottoscrizione all'evento.
2. Schema di autenticazione proxy: seleziona il tipo di autenticazione per 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 proxy: seleziona il secret di Secret Manager associato alla password dell'utente.
5. Versione 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 il 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.

Suggerimento:per comprendere come utilizzare l'iscrizione all'evento nel tuo integrazioni, vedi Trigger di Zendesk.

Entità, operazioni e azioni

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

Nota: puoi visualizzare le entità, le operazioni e le azioni di un nell'attività Connettori.

• Entità: un'entità può essere considerata un oggetto o un insieme di proprietà nel un'applicazione o un servizio connesso. La definizione di un'entità differisce da connettore di rete. Ad esempio, in un connettore di database, le tabelle sono le entità, connettore 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 disponga di entità. In questo caso, L'elenco Entities sarà vuoto.

• Operazione: un'operazione è l'attività che è possibile eseguire su un'entità. Puoi eseguire una qualsiasi delle seguenti operazioni su un'entità:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  Selezionando un'entità dall'elenco disponibile, viene generato un elenco di le operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta operazioni relative a entità. Tuttavia, se un connettore non supporta nessuna delle operazioni relative alle entità, ad esempio operazioni 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à variano da connettore a connettore. Normalmente, un'azione ha alcuni parametri di input e un output . Tuttavia, è possibile che un connettore non supporta alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Nota : a tutte le entità e alle azioni è associato uno schema. Ad esempio, uno schema delle azioni avrà i dettagli dei parametri, come ad esempio il parametro e il tipo di dati corrispondente. Lo schema (metadati) per entità e azioni viene recuperato dalla connessione in dal tuo backend. In caso di aggiornamenti allo schema, questi aggiornamenti non saranno si riflette automaticamente sulle connessioni esistenti; devi aggiornare manualmente lo schema. Per aggiornare lo schema di una connessione, apri la pagina Dettagli connessione della connessione e fai clic su Aggiorna lo schema di connessione.

Limitazioni di sistema

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

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

Nota: il numero di nodi di Integration Connectors verrà scalato automaticamente in modo dinamico in base al tuo utilizzo. Se invece vuoi prenotare capacità per volumi elevati senza in attesa della scalabilità automatica, puoi regolare il valore minimo del nodo per una connessione. Altro i nodi sono necessari per elaborare più transazioni per una connessione. Al contrario, un numero minore di nodi sono necessarie se una connessione elabora meno transazioni. a configurare il nodo :

• Se sei un cliente con pagamento a consumo, configura il valore minimo e massimo dei nodi nella pagina Modifica connessione.
• Se hai un abbonamento basato su abbonamento Cliente, contatta l'assistenza.

Il numero massimo di transazioni che un nodo è in grado di gestire dipende da vari fattori. Quindi, prima di regolare il numero minimo di nodi per migliorare la velocità effettiva, è consigliabile verificare che i sistemi di backend siano configurati in modo ottimale per gestire il traffico richiesto.

Azioni

Il connettore Zendesk fornisce azioni per gestire i ticket in base al ticket ID. Per capire come configurare azioni, consulta la sezione Esempi di azioni.

Esempi di azioni

In questa sezione viene descritto come eseguire alcune 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 e fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value:

   {
     "Id": "18"
   }
   

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

[{
  "Success": "true"
}] 

.

Nota: l'operazione DeleteTicketsPermanently è stata permanente un record. Se vuoi eseguire un'eliminazione temporanea, utilizza l'operazione di eliminazione dell'entità.

Esempio - Unire i ticket

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

   {
     "Id": "25",
     "Id": "26"
   }  
   

Questo esempio unisce i due ticket. Se l'azione ha esito positivo, 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 e fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value:

   {
     "id": "20"
   } 
   

In questo esempio viene ripristinato un ticket. Se l'azione ha esito positivo, 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 e fai clic su Fine.
3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value:

   {
     "id": "18726501985809"
   } 
   

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

[{
  "Id": "60921"
}]  

Esempi di operazioni con entità

Esempio: elenca 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 e fai clic su Fine.

Esempio: Acquisto di un ticket

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

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

   In questo caso, 35 è il valore della chiave primaria dell'entità Tickets.

Esempio: creare un ticket

Questo esempio crea 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 e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella 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 simile al seguente:

    {
       "Id": 38.0
     } 
     

Esempio: aggiornare 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 e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload, quindi inserisci un valore simile al seguente nella Campo Default Value:

   {
         "Subject": "Zendesk_Ticket_Update",
         "Description": "Updating the ticket",
         "RequesterId": 1.6854335860497E13
       }
       

5. Fai clic su entityId e inserisci 35 nel campo Default Value (Valore predefinito).

   In alternativa, invece di specificare entityId, puoi anche impostare il parametro filterClause su 35.

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

   {
          Id": 35.0
       }
       

Esempio: eliminare un ticket

In questo esempio viene eliminato 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 e fai clic su Fine.
4. Nella sezione Input attività dell'attività Connettori, fai clic su entityId e quindi inserisci 35 nel campo Valore predefinito.

Nota: l'operazione Delete esegue solo un'eliminazione temporanea del record. Se necessario, puoi recuperare in un secondo momento il record eliminato.

Utilizzare Terraform per creare connessioni

Puoi utilizzare il comando Terraform risorsa 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 di connessioni, vedi il modello di esempio.

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

Nome parametro	Tipo di dati	Obbligatorio	Descrizione
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 sul proxy ProxyServer. I valori supportati sono: BASIC, DIGEST, NONE
proxy_user	STRINGA	Falso	Un nome utente da utilizzare per l'autenticazione sul proxy ProxyServer.
proxy_password	SECRET	Falso	Una password da utilizzare per l'autenticazione sul proxy ProxyServer.
proxy_ssltype	ENUM	Falso	Il tipo SSL da utilizzare per la connessione al proxy ProxyServer. I valori supportati sono: AUTO, ALWAYS, NEVER, TUNNEL

Utilizzare la connessione Zendesk in un'integrazione

Dopo aver creato la connessione, questa diventa disponibile in Apigee Integration e Application Integration. Puoi usare la connessione in un'integrazione tramite l'attività Connettori.

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

Ricevi assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore in Google Cloud community presso i forum Cloud.

Passaggi successivi

• Scopri come sospendere e ripristinare una connessione.
• Scopri come monitorare l'utilizzo dei connettori.
• Scopri come visualizzare i log del connettore.