Zendesk

Le connecteur Zendesk vous permet d'effectuer des opérations d'insertion, de suppression, de mise à jour et de lecture sur une base de données Zendesk.

Versions compatibles

Ce connecteur est compatible avec les API Zendesk version 2.

Avant de commencer

Avant d'utiliser le connecteur Zendesk, effectuez les tâches suivantes :

  • Dans votre projet Google Cloud :
    • Assurez-vous que la connectivité réseau est configurée. Pour en savoir plus sur les schémas de réseau, consultez Connectivité réseau.
    • Attribuez le rôle IAM roles/connectors.admin à l'utilisateur qui configure le connecteur.
    • Attribuez les rôles IAM suivants au compte de service que vous souhaitez utiliser pour le connecteur :
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un compte de service est un type spécial de compte Google destiné à représenter un utilisateur non humain qui doit s'authentifier et obtenir les autorisations permettant d'accéder aux données des API Google. Si vous ne possédez pas de compte de service, vous devez en créer un. Pour plus d'informations, consultez Créer un compte de service.

    • Activez les services suivants :
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Pour savoir comment activer des services, consultez Activer des services.

    Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer au moment de configurer le connecteur.

  • Si vous souhaitez utiliser votre adresse e-mail et votre mot de passe pour accéder à l'API Zendesk, activez password access dans le centre d'administration de Zendesk. Pour en savoir plus, consultez Basic authentication (Authentification de base).
  • Pour savoir comment créer un compte Zendesk, consultez Create a Zendesk Account (Créer un compte Zendesk).

Configurer le connecteur

Une connexion est propre à une source de données. Cela signifie que si vous disposez de nombreuses sources de données, vous devez créer une connexion distincte pour chacune d'elles. Pour créer une connexion, procédez comme suit :

  1. Dans la console Cloud, accédez à la page Connecteurs d'intégration > Connexions, puis sélectionnez ou créez un projet Google Cloud.

    Accéder à la page "Connexions"

  2. Cliquez sur + CRÉER pour ouvrir la page Créer une connexion.
  3. Dans la section Emplacement, choisissez l'emplacement de la connexion.
    1. Région : sélectionnez un emplacement dans la liste déroulante.

      Pour obtenir la liste de toutes les régions disponibles, consultez Emplacements.

    2. Cliquez sur SUIVANT.
  4. Dans la section Détails de connexion, procédez comme suit :
    1. Connecteur : sélectionnez Zendesk dans la liste déroulante des connecteurs disponibles.
    2. Version du connecteur : sélectionnez la version du connecteur dans la liste déroulante des versions disponibles.
    3. Dans le champ Nom de connexion, indiquez le nom de l'instance de connexion.

      Les noms de connexion doivent répondre aux critères suivants :

      • Ils peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Ils doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Ils ne peuvent pas dépasser 49 caractères.
      • Pour les connecteurs qui acceptent les abonnements aux événements, les noms de connexion ne peuvent pas commencer par le préfixe "goog".
    4. (Facultatif) Saisissez une description de l'instance de connexion.
    5. (Facultatif) Activez Cloud Logging, puis sélectionnez un niveau de journalisation. Par défaut, le niveau de journalisation est défini sur Error.
    6. Compte de service : sélectionnez un compte de service disposant des rôles requis.
    7. Pour utiliser la connexion pour les abonnements aux événements, sélectionnez Activer l'abonnement aux événements. Si vous sélectionnez cette option, les options suivantes s'affichent :
      • Activer l'abonnement aux événements avec entité et actions : sélectionnez cette option pour utiliser la connexion à la fois pour l'abonnement aux événements et les opérations de connecteur (entités et actions).
      • Activer uniquement l'abonnement aux événements : sélectionnez cette option afin d'utiliser la connexion uniquement pour l'abonnement aux événements. Si vous sélectionnez cette option, cliquez sur Suivant, puis configurez l'abonnement aux événements.
    8. (Facultatif) Configurez les paramètres de nœuds de connexion :

      • Nombre minimal de nœuds : saisissez le nombre minimal de nœuds de connexion.
      • Nombre maximal de nœuds : saisissez le nombre maximal de nœuds de connexion.

      Un nœud est une unité (ou instance répliquée) de connexion qui traite des transactions. Pour traiter davantage de transactions pour une connexion, vous devez disposer de plus de nœuds. À l'inverse, moins de nœuds sont nécessaires si une connexion traite moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez Tarifs des nœuds de connexion. Si vous ne saisissez aucune valeur, le nombre minimal de nœuds est défini par défaut sur 2 (pour améliorer la disponibilité) et le nombre maximal de nœuds sur 50.

    9. Utiliser un proxy : cochez cette case afin de configurer un serveur proxy pour la connexion ainsi que les valeurs suivantes :
      • Schéma d'authentification du proxy : sélectionnez le type d'authentification pour l'authentification auprès du serveur proxy. Les types d'authentification suivants sont compatibles :
        • De base : authentification HTTP de base.
        • Digest : authentification HTTP Digest.
      • Utilisateur du proxy : nom d'utilisateur permettant de s'authentifier auprès du serveur proxy.
      • Mot de passe du proxy : secret Secret Manager du mot de passe de l'utilisateur.
      • Type SSL du proxy : type SSL à utiliser lors de la connexion au serveur proxy. Les types d'authentification suivants sont compatibles :
        • Auto : paramètre par défaut. Dans le cas d'une URL HTTPS, l'option "Tunnel" est utilisée. Dans le cas d'une URL HTTP, l'option "Jamais" est utilisée.
        • Toujours : la connexion est activée pour SSL.
        • Jamais : la connexion n'est pas activée pour SSL.
        • Tunnel : la connexion s'effectue avec un proxy de tunnelisation. Le serveur proxy ouvre une connexion à l'hôte distant et le trafic transite par le proxy.
      • Dans la section Serveur proxy, saisissez les détails du serveur proxy.
        1. Cliquez sur + Ajouter une destination.
        2. Sélectionnez un type de destination.
          • Adresse de l'hôte : spécifiez le nom d'hôte ou l'adresse IP de la destination.

            Si vous souhaitez établir une connexion privée à votre système backend, procédez comme suit :

    10. (Facultatif) Cliquez sur + AJOUTER UNE ÉTIQUETTE pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
    11. Cliquez sur SUIVANT.
  5. Dans la section Destinations, saisissez des informations sur l'hôte distant (système backend) auquel vous souhaitez vous connecter.
    1. Type de destination : sélectionnez un type de destination.
      • Sélectionnez Adresse de l'hôte dans la liste pour spécifier le nom d'hôte ou l'adresse IP de la destination.
      • Si vous souhaitez établir une connexion privée à vos systèmes backend, sélectionnez Rattachement de point de terminaison dans la liste, puis sélectionnez le rattachement de point de terminaison requis dans la liste Rattachement de point de terminaison.

      Si vous souhaitez établir une connexion publique à vos systèmes backend avec une sécurité supplémentaire, vous pouvez envisager de configurer des adresses IP sortantes statiques pour vos connexions, puis de configurer vos règles de pare-feu pour ajouter à la liste d'autorisation uniquement les adresses IP statiques spécifiques.

      Pour saisir d'autres destinations, cliquez sur + AJOUTER UNE DESTINATION.

    2. Cliquez sur SUIVANT.
  6. Dans la section Authentification, saisissez les informations d'authentification.
    1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.

      Les types d'authentification suivants sont compatibles avec la connexion Zendesk :

      • Nom d'utilisateur et mot de passe
      • Jeton d'API
      • Code d'autorisation OAuth 2.0
    2. Pour savoir comment configurer ces types d'authentification, consultez Configurer l'authentification.

    3. Cliquez sur SUIVANT.
  7. Si vous avez activé l'abonnement aux événements, la section Détails de l'abonnement aux événements s'affiche sur la page de création de la connexion. Pour savoir comment configurer les détails de l'abonnement aux événements, consultez Configurer l'abonnement aux événements.
  8. Vérifier : vérifiez vos informations de connexion et d'authentification.
  9. Cliquez sur Créer.

Configurer l'authentification

Saisissez les informations en fonction de l'authentification que vous souhaitez utiliser.

  • Nom d'utilisateur et mot de passe
    • Nom d'utilisateur : nom d'utilisateur Zendesk à utiliser pour la connexion
    • Mot de passe : secret Secret Manager contenant le mot de passe associé au nom d'utilisateur Zendesk
  • Jeton d'API
    • Utilisateur : compte utilisateur Zendesk utilisé pour l'authentification
    • Jeton d'API : jeton d'API de l'utilisateur authentifié
    • Version du secret: version du secret
  • Code d'autorisation OAuth 2.0
    • ID client : ID client fourni par le connecteur pour l'application que vous avez créée
    • Niveaux d'accès : liste des niveaux d'accès souhaités, séparés par une virgule
    • Code secret du client : secret Secret Manager contenant le code secret du client pour l'application connectée que vous avez créée
    • Version du secret: version du secret
    • URL d'autorisation : URL d'autorisation générée lors de la création du client dans l'instance Zendesk

Configurer l'abonnement aux événements

Si vous avez activé l'abonnement aux événements, saisissez les valeurs suivantes dans la section Détails de l'abonnement aux événements :

  1. Sélectionnez un type de destination.
    • Adresse de l'hôte : saisissez l'URL d'enregistrement de votre système backend dans le champ hôte.
  2. Saisissez les informations d'authentification.
    1. Nom d'utilisateur : saisissez le nom d'utilisateur.
    2. Mot de passe : sélectionnez le secret Secret Manager contenant le mot de passe associé au nom d'utilisateur.
    3. Version du secret : sélectionnez la version du secret.
  3. (Facultatif) Sélectionnez Activer l'enrichissement des données pour ajouter des informations supplémentaires à la réponse du système backend.

    Les informations supplémentaires sont propres à l'entité pour laquelle vous avez configuré l'événement. Pour en savoir plus, consultez Enrichir les données dans les notifications d'événements.

  4. Sélectionnez Activer la connectivité privée pour la connectivité sécurisée entre votre application backend et votre connexion. Si vous sélectionnez cette option, vous devez effectuer des étapes de configuration supplémentaires après avoir créé la connexion. Pour en savoir plus, consultez Connectivité privée pour l'abonnement aux événements.
  5. Saisissez la configuration de lettres mortes. Si vous configurez les lettres mortes, la connexion écrit les événements non traités dans le sujet Pub/Sub spécifié. Saisissez les informations suivantes :
    1. ID du projet de lettres mortes : ID du projet Google Cloud dans lequel vous avez configuré la file d'attente Pub/Sub de lettres mortes.
    2. File d'attente de lettres mortes : sujet Pub/Sub dans lequel vous souhaitez écrire les détails de l'événement non traité.
  6. Si vous souhaitez utiliser un proxy pour vous connecter à votre backend (pour l'abonnement aux événements), saisissez les informations suivantes :
    1. Type SSL du proxy : type SSL à utiliser lors de la connexion au serveur proxy. Sélectionnez l'un des types d'authentification suivants :
      • Toujours : le protocole SSL est toujours activé pour la connexion pour l'abonnement aux événements.
      • Jamais : le protocole SSL n'est pas activé pour la connexion pour l'abonnement aux événements.
    2. Schéma d'authentification du proxy : sélectionnez le type d'authentification pour l'authentification auprès du serveur proxy. Les types d'authentification suivants sont compatibles :
      • De base : authentification HTTP de base.
    3. Utilisateur du proxy : saisissez le nom d'utilisateur permettant de s'authentifier auprès du serveur proxy.
    4. Mot de passe du proxy : sélectionnez le secret Secret Manager du mot de passe de l'utilisateur.
    5. Version du secret : sélectionnez la version du secret.
    6. Dans la section Serveur proxy, saisissez les détails du serveur proxy.
      1. Cliquez sur + Ajouter une destination, puis sélectionnez Adresse de l'hôte dans le champ Type de destination.
      2. Saisissez le nom d'hôte ou l'adresse IP du serveur proxy, ainsi que le numéro de port du serveur proxy.

Exemples de configuration de connexion

Type de connexion avec authentification de base

Nom du champ Détails
Emplacement us-east4
Connecteur Zendesk
Version du connecteur 1
Nom de connexion NOM_CONNEXION
Activer Cloud Logging Oui
Compte de service SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Hôte ADRESSE_HÔTE
Mot de passe utilisateur Oui
Nom d'utilisateur NOM D'UTILISATEUR
Mot de passe MOT DE PASSE
Version du secret 1

Type de connexion avec un jeton d'API

Nom du champ Détails
Emplacement europe-west1
Connecteur Zendesk
Version du connecteur 1
Nom de connexion zendesk-apitoken
Activer Cloud Logging Oui
Compte de service SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Nombre minimal de nœuds 2
Nombre maximal de nœuds 50
Type de destination Adresse de l'hôte
Hôte 1 https://yoursubdomain.zendesk.com
Authentification Jeton d'API
Utilisateur NomUtilisateur
Jeton d'API Jeton d'API fourni par votre application
Version du secret 1

Type de connexion avec un code d'autorisation OAuth 2.0

Nom du champ Détails
Emplacement europe-west1
Connecteur Zendesk
Version du connecteur 1
Nom de connexion zendesk-auth-code
Activer Cloud Logging Oui
Compte de service SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Nombre minimal de nœuds 2
Nombre maximal de nœuds 50
Type de destination Adresse de l'hôte
Hôte 1 https://yoursubdomain.zendesk.com
Authentification Code d'autorisation OAuth 2.0
ID client ID_CLIENT
Niveaux d'accès Niveaux d'accès requis comme cas d'utilisation
Code secret du client SECRET_CLIENT
Version du secret 1
URL d'autorisation https://d3v2one1625553311.zendesk.com/oauth/authorizations/new

La connexion à Zendesk utilise le protocole SSL par défaut. Aucune configuration supplémentaire n'est nécessaire si vous utilisez l'URL Zendesk standard, par exemple https://yoursubdomain.zendesk.com.

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

  • Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.

    Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

  • Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :

    Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.

  • Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Limites du système

Le connecteur Zendesk peut traiter au maximum cinq transactions par seconde et par nœud, et limite les transactions au-delà de ce seuil. Par défaut, Integration Connectors alloue deux nœuds (pour améliorer la disponibilité) à une connexion.

Pour en savoir plus sur les limites applicables à Integration Connectors, consultez Limites.

Actions

Le connecteur Zendesk fournit des actions pour gérer vos tickets en fonction du ticket ID. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Supprimer un ticket

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action DeleteTicketsPermanently, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
      "Id": "18"
    }
  4. Cet exemple supprime le ticket de manière définitive. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
      "Success": "true"
    }] 

Exemple : Fusionner des tickets

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action MergeTickets, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
      "Id": "25",
      "Id": "26"
    }
  4. Cet exemple fusionne les deux tickets. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

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

Exemple : Restaurer un ticket

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action RestoreTicket, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
      "id": "20"
    }
  4. Cet exemple restaure un ticket. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
      "Success": "true"
    }] 

Exemple : Restaurer un ticket suspendu

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
  2. Sélectionnez l'action RecoverSuspendedTicket, puis cliquez sur OK.
  3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
      "id": "18726501985809"
    }
  4. Cet exemple restaure un ticket suspendu. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    [{
      "Id": "60921"
    }]

Exemples d'opérations d'entité

Exemple : Effectuer une opération List sur l'entité Tickets

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Tickets dans la liste Entity.
  3. Sélectionnez l'opération List, puis cliquez sur OK.
  4. Vous pouvez effectuer une opération List sur les entités suivantes :

    Attachments, TicketComments, TicketForms, TicketFields, Requests, TicketAudits, TicketMetrics, SuspendedTickets, SharingAgreements, Users, UserIdentities, UserRelatedInformation, UserFields, OrganizationFields et JobStatus

Exemple : Effectuer une opération Get sur l'entité Tickets

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Tickets dans la liste Entity.
  3. Sélectionnez l'opération Get, puis cliquez sur OK.
  4. Ici, l'entityId est défini sur "34.0". Pour définir l'entityId, dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez "34.0" dans le champ Default Value.
  5. Vous pouvez effectuer une opération Get sur les entités suivantes :

    TicketForms, TicketFields, Requests, TicketAudits, SuspendedTickets, UserFields, UserIdentities et Users

Exemple : Effectuer une opération Create sur l'entité Tickets

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Tickets dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ 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"
      }
      

    Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

     {
        "Id": 38.0
      }
      

Exemple : Effectuer une opération Create sur l'entité TicketForms

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez TicketForms dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ 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
      }
      

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche TicketForms aura une valeur semblable à la suivante :

    {
        "Id":1.8104712053393E13
      }
      

Exemple : Effectuer une opération Create sur l'entité TicketFields

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez TicketFields dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ 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
      }
      

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche TicketFields aura une valeur semblable à la suivante :

    {
        "Id": 1.7139061374865E13
      }
      

Exemple : Effectuer une opération Create sur l'entité SharingAgreements

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez SharingAgreements dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
        "Name": "altostrat.zendesk.com",
        "RemoteSubdomain": "altostrat"
      }
      

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche SharingAgreements aura une valeur semblable à la suivante :

    {
        "Id": 1.7142672288273E13
      }
      

Exemple : Effectuer une opération Create sur l'entité Users

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Users dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
        "Email": "cloudysanfrancisco@gmail.com",
        "Name": "Altostrat Team"
      }
      

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche Users aura une valeur semblable à la suivante :

    {
        "Id": 1.7156912480273E13
      }
      

Exemple : Effectuer une opération Create sur l'entité UserIdentities

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez UserIdentities dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ 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"
      }
      

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche UserIdentities aura une valeur semblable à la suivante :

    {
        "Id": 1.6961185982353E13
      } 
      

Exemple : Effectuer une opération Create sur l'entité UserFields

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez UserFields dans la liste Entity.
  3. Sélectionnez l'opération Create, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
        "Title": "Support description",
        "Type": "text",
        "Key": "support_description"
      }
      

    Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche UserFields aura une valeur semblable à la suivante :

    {
        "Id": 1.7157236761873E13
      }
      

Exemple : Effectuer une opération Update sur l'entité Tickets

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Tickets dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ 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. Ici, l'entityId est défini sur "35.0". Pour définir l'entityId, cliquez sur entityId, puis saisissez 35 dans le champ Valeur par défaut.

    Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 35.

    Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

    {
          Id": 35.0
      }
      

Exemple : Effectuer une opération Update sur l'entité TicketForms

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez TicketForms dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
        "Name": "Ticketforms Updated",
        "DisplayName": "Altostrat_Issues1",
        "RawDisplayName": "Altostrat_Issues1"
      }
      
  5. Ici, l'entityId est défini sur "1.7137314972689E13". Pour définir l'entityId, cliquez sur entityId, puis saisissez 1.7137314972689E13 dans le champ Valeur par défaut.

    Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 1.7137314972689E13.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

    {
          Id": 1.7137314972689E13
      }
      

Exemple : Effectuer une opération Update sur l'entité TicketFields

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez TicketFields dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
        "Description": "Updated description for testing"
      }
      
  5. Ici, l'entityId est défini sur "3.60022990118E11". Pour définir l'entityId, cliquez sur entityId, puis saisissez 3.60022990118E11 dans le champ Valeur par défaut.

    Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 3.60022990118E11.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

    {
          Id": 3.60022990118E11
      }
      

Exemple : Effectuer une opération Update sur l'entité Users

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Users dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
        "Name": "The Customer update",
        "Last Name": "Alex",
        "First Name": "Charlie"
      }
      
  5. Ici, l'entityId est défini sur "3.84625885158E11". Pour définir l'entityId, cliquez sur entityId, puis saisissez 3.84625885158E11 dans le champ Valeur par défaut.

    Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 3.84625885158E11.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

    {
          Id": 3.84625885158E11
      }
      

Exemple : Effectuer une opération Update sur l'entité UserFields

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez UserFields dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
        "Title": "Support description updated",
        "Type": "text",
        "Key": "support_description"
      }
      
  5. Ici, l'entityId est défini sur "1.7157236761873E13". Pour définir l'entityId, cliquez sur entityId, puis saisissez 1.7157236761873E13 dans le champ Valeur par défaut.

    Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 1.7157236761873E13.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

    {
          Id": 1.7157236761873E13
      }
      

Exemple : Effectuer une opération Update sur l'entité UserIdentities

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez UserIdentities dans la liste Entity.
  3. Sélectionnez l'opération Update, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :
    {
        "Verified": true
      }
      
  5. Dans cette entité, l'opération Update peut être effectuée à l'aide d'une clause de filtre et de clés primaires composites. L'entityId n'est donc pas obligatoire.
  6. Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur UserId='384625885158' and Id='368234205078'.

    L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

    {
        "Id": 3.68234205078E11
      }
      

Exemple : Effectuer une opération Delete sur l'entité Tickets

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Tickets dans la liste Entity.
  3. Sélectionnez l'opération Delete, puis cliquez sur OK.
  4. Ici, l'entityId est défini sur "35.0". Pour définir l'entityId, dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 35 dans le champ Valeur par défaut.
  5. Vous pouvez effectuer une opération Delete sur les entités suivantes :

    TicketFields, SuspendedTickets, UserIdentities, UserFields et Users

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser la ressource Terraform pour créer une connexion.

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez Commandes Terraform de base.

Pour afficher un exemple de modèle Terraform permettant de créer une connexion, consultez Exemple de modèle.

Lorsque vous créez cette connexion à l'aide de Terraform, vous devez définir les variables suivantes dans votre fichier de configuration Terraform :

Nom du paramètre Type de données Obligatoire Description
proxy_enabled BOOLEAN False Cochez cette case afin de configurer un serveur proxy pour la connexion.
proxy_auth_scheme ENUM False Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Valeurs acceptées : BASIC, DIGEST et NONE.
proxy_user STRING False Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
proxy_password SECRET False Mot de passe à utiliser pour s'authentifier auprès du proxy ProxyServer.
proxy_ssltype ENUM False Type SSL à utiliser lors de la connexion au proxy ProxyServer. Valeurs acceptées : AUTO, ALWAYS, NEVER et TUNNEL.

Utiliser la connexion Zendesk dans une intégration

Une fois la connexion créée, elle devient disponible dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion dans une intégration au moyen de la tâche "Connecteurs".

  • Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Apigee Integration, consultez Tâche "Connecteurs".
  • Pour savoir comment créer et utiliser la tâche "Connecteurs" dans Application Integration, consultez Tâche "Connecteurs".

Demander de l'aide à la communauté Google Cloud

Vous pouvez publier vos questions et discuter de ce connecteur sur les forums Cloud de la communauté Google Cloud.

Étapes suivantes