Zendesk

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.
• Token API
  • Utente: l'account utente Zendesk utilizzato per l'autenticazione.
  • Token API: il token API dell'utente autenticato.
  • Versione secret: versione secret del secret.
• OAuth 2.0 - Codice di autorizzazione
  • ID client: l'ID client fornito dal connettore per l'app che hai creato.
  • Ambiti: un elenco separato da virgole degli ambiti desiderati.
  • Client secret: secret di Secret Manager contenente il client secret per l'app connessa che hai creato.
  • Versione secret: versione secret del secret.
  • Authorization URL (URL di autorizzazione): l'URL di autorizzazione generato durante la creazione del client nell'istanza Zendesk.

Configurare 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 del secret: seleziona la versione del secret.
3. (Facoltativo) Seleziona Attiva arricchimento dei dati se vuoi che vengano aggiunte ulteriori informazioni alla risposta del sistema di backend.

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

4. Seleziona Attiva connettività privata per una connettività sicura tra l'applicazione di backend e la connessione. Se selezioni questa opzione, devi eseguire passaggi di configurazione aggiuntivi dopo aver creato la connessione. Per saperne di più, consulta Connettività privata per la sottoscrizione di eventi.
5. Inserisci la configurazione della coda di messaggi non recapitabili. Se configuri la coda dei 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 di eventi), inserisci i seguenti dettagli:
1. Tipo di SSL proxy: il tipo di 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 di eventi.
   • Mai: la connessione non è abilitata per SSL per la sottoscrizione di eventi.
2. 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.
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 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 poi 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.

Esempi di configurazione della connessione

Tipo di connessione per l'autenticazione di base

Tipo di connessione con token API

OAuth 2.0 - Tipo di connessione con codice di autorizzazione

La connessione a Zendesk utilizza SSL per impostazione predefinita e non è necessaria alcuna configurazione aggiuntiva se utilizzi l'URL Zendesk standard, ad esempio https://yoursubdomain.zendesk.com.

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à:
  • Elenca
  • Scarica
  • Crea
  • Aggiorna
  • Elimina

  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.

Limitazioni di sistema

Il connettore Zendesk può elaborare 5 transazioni al secondo, per nodo, e limita le transazioni 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.

Azioni

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

Esempi di azioni

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

Esempio: eliminare un biglietto

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 poi inserisci un valore simile al seguente nel campo Default Value:

   {
     "Id": "18"
   }

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: unire i biglietti

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 poi inserisci un valore simile al seguente nel campo Default Value:

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

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 poi inserisci un valore simile al seguente nel campo Default Value:

   {
     "id": "20"
   }

Questo esempio ripristina 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 poi inserisci un valore simile al seguente nel campo Default Value:

   {
     "id": "18726501985809"
   }

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 sulle entità

Esempio: operazione di elenco sui ticket

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

Puoi eseguire l'operazione List sulle seguenti entità:

Allegati, commenti ai ticket, moduli dei ticket, campi dei ticket, richieste, audit dei ticket, metriche dei ticket, ticket sospesi, accordi di condivisione, utenti, identità utente, informazioni correlate all'utente, campi utente, campi dell'organizzazione e stato del lavoro

Esempio: ottieni l'operazione sui biglietti

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. In questo caso, entityId è impostato su 34.0. Per impostare entityId, nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 34.0 nel campo Default Value.

Puoi eseguire l'operazione Get sulle seguenti entità:

Moduli dei ticket, campi dei ticket, richieste, audit dei ticket, ticket sospesi, campi utente, identità utente e utenti

Esempio: crea operazione sui ticket

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 poi inserisci un valore simile al seguente nel campo Default Value:

   {
       "Subject": "Zendesk_Create_Ticket",
       "RawSubject": "Zendesk_Create",
       "Description": "this ticket is related to application integration Create operation",
       "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,
       "Tags": null,
       "ViaChannel": "web",
       "ViaSource": "{\r\n  \"from\": null,\r\n  \"to\": null,\r\n  \"rel\": null\r\n}",
       "CustomFields": null,
       "SatisfactionRating": null,
       "SharingAgreementIds": null,
       "AllowChannelback": false,
       "IsPublic": true,
       "Url": "https://altostrat.zendesk.com/api/v2/tickets/1.json"
     }
     

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

    {
       "Id": 38.0
     }
     

Esempio: crea operazione su TicketForms

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona TicketForms 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:

   {
       "Name": "Altostrat_Zendesk1",
       "RawName": "Altostrat_Zendesk1",
       "DisplayName": "Altostrat_Issues1",
       "RawDisplayName": "Altostrat_Issues1",
       "Position": 2.0,
       "Active": true,
       "EndUserVisible": true,
       "Default": false,
       "InAllBrands": true,
       "RestrictedBrandIds": null,
       "FallbackToDefault": null,
       "AssociatedToBrand": null
     }
     

   Se l'integrazione ha esito positivo, il parametro TicketForms della risposta connectorOutputPayload avrà un valore simile al seguente:

   {
       "Id":1.8104712053393E13
     }
     

Esempio: crea operazione su TicketFields

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona TicketFields 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:

   {
       "Type": "text",
       "Title": "New field created",
       "RawTitle": null,
       "Description": "Please create the new field",
       "RawDescription": null,
       "Position": 2.0,
       "Active": true,
       "Required": false,
       "CollapsedForAgents": false,
       "RegexpForValidation": null,
       "VisibleInPortal": true,
       "EditableInPortal": true,
       "Tag": null,
       "CreatedAt": "2021-07-06 06:35:19.0",
       "UpdatedAt": "2021-07-06 06:35:19.0",
       "SystemFieldOptions": null,
       "CustomFieldOptions": null,
       "Removable": false
     }
     

   Se l'integrazione ha esito positivo, il parametro TicketFields della risposta connectorOutputPayload avrà un valore simile al seguente:

   {
       "Id": 1.7139061374865E13
     }
     

Esempio: operazione di creazione su SharingAgreements

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona SharingAgreements 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:

   {
       "Name": "altostrat.zendesk.com",
       "RemoteSubdomain": "altostrat"
     }
     

   Se l'integrazione ha esito positivo, il parametro SharingAgreements della risposta connectorOutputPayload avrà un valore simile al seguente:

   {
       "Id": 1.7142672288273E13
     }
     

Esempio: operazione di creazione sugli utenti

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Users 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:

   {
       "Email": "cloudysanfrancisco@gmail.com",
       "Name": "Altostrat Team"
     }
     

   Se l'integrazione ha esito positivo, il parametro Users della risposta connectorOutputPayload avrà un valore simile al seguente:

   {
       "Id": 1.7156912480273E13
     }
     

Esempio: crea un'operazione su UserIdentities

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona UserIdentities 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:

   {
       "UserId": 3.84637722338E11,
       "Type": "email",
       "Value": "cloudysanfrancisco@gmail.com",
       "Verified": false,
       "Primary": true,
       "DeliverableState": "reserved_example",
       "Url": "https://d3valtostrat1625553311.zendesk.com/api/v2/users/384637722338/identities/368240277818.json"
     }
     

   Se l'integrazione ha esito positivo, il parametro UserIdentities della risposta connectorOutputPayload avrà un valore simile al seguente:

   {
       "Id": 1.6961185982353E13
     } 
     

Esempio: operazione di creazione su UserFields

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona UserFields 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:

   {
       "Title": "Support description",
       "Type": "text",
       "Key": "support_description"
     }
     

   Se l'integrazione ha esito positivo, il parametro UserFields della risposta connectorOutputPayload avrà un valore simile al seguente:

   {
       "Id": 1.7157236761873E13
     }
     

Esempio: operazione di aggiornamento dei ticket

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Tickets 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:

   {
       "Subject": "Google_Altostrat_Zendesk Update",
       "RawSubject": "Google_Altostrat_Zendesk Update",
       "Description": "this ticket is related to googlecloud application integration update check",
       "RequesterId": 1.6854335860497E13
     }
     

5. In questo caso, entityId è impostato su 35.0. Per impostare entityId, fai clic su entityId, quindi inserisci 35 nel campo Valore predefinito.

   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: operazione di aggiornamento su TicketForms

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona TicketForms 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:

   {
       "Name": "Ticketforms Updated",
       "DisplayName": "Altostrat_Issues1",
       "RawDisplayName": "Altostrat_Issues1"
     }
     

5. In questo caso, entityId è impostato su 1.7137314972689E13. Per impostare entityId, fai clic su entityId e poi inserisci 1.7137314972689E13 nel campo Valore predefinito.

   Anziché specificare entityId, puoi anche impostare filterClause su 1.7137314972689E13.

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

   {
         Id": 1.7137314972689E13
     }
     

Esempio: operazione di aggiornamento su TicketFields

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona TicketFields 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:

   {
       "Description": "Updated description for testing"
     }
     

5. In questo caso, entityId è impostato su 3.60022990118E11. Per impostare entityId, fai clic su entityId e poi inserisci 3.60022990118E11 nel campo Valore predefinito.

   Anziché specificare entityId, puoi anche impostare filterClause su 3.60022990118E11.

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

   {
         Id": 3.60022990118E11
     }
     

Esempio: operazione di aggiornamento sugli utenti

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Users 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:

   {
       "Name": "The Customer update",
       "Last Name": "Alex",
       "First Name": "Charlie"
     }
     

5. In questo caso, entityId è impostato su 3.84625885158E11. Per impostare entityId, fai clic su entityId e poi inserisci 3.84625885158E11 nel campo Valore predefinito.

   Anziché specificare entityId, puoi anche impostare filterClause su 3.84625885158E11.

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

   {
         Id": 3.84625885158E11
     }
     

Esempio: operazione di aggiornamento su UserFields

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona UserFields 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:

   {
       "Title": "Support description updated",
       "Type": "text",
       "Key": "support_description"
     }
     

5. In questo caso, entityId è impostato su 1.7157236761873E13. Per impostare entityId, fai clic su entityId e poi inserisci 1.7157236761873E13 nel campo Valore predefinito.

   Anziché specificare entityId, puoi anche impostare filterClause su 1.7157236761873E13.

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

   {
         Id": 1.7157236761873E13
     }
     

Esempio: operazione di aggiornamento su UserIdentities

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona UserIdentities 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:

   {
       "Verified": true
     }
     

5. In questa entità, l'operazione di aggiornamento può essere eseguita utilizzando la clausola di filtro e le chiavi primarie composite, pertanto entityId non è richiesto.

Anziché specificare entityId, puoi anche impostare filterClause come UserId='384625885158' and Id='368234205078' .

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

{
    "Id": 3.68234205078E11
  }
  

Esempio: operazione di eliminazione sui ticket

1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
2. Seleziona Tickets dall'elenco Entity.
3. Seleziona l'operazione Delete, quindi fai clic su Fine.
4. In questo caso, entityId è impostato su 35.0. Per impostare entityId, nella sezione Input attività dell'attività Connettori, fai clic su entityId e poi inserisci 35 nel campo Valore predefinito.

Puoi eseguire l'operazione di eliminazione sulle seguenti entità:

Campi ticket, Ticket sospesi, UserIdentities, Campi utente e Utenti

Utilizzare la connessione Zendesk 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.