Zuora

Le connecteur Zuora vous permet de vous connecter à une instance Zuora et d'accéder aux données Zuora sous forme de base de données traditionnelle.

Versions compatibles

Ce connecteur utilise l'API Zuora version 1 pour permettre un accès bidirectionnel à Zuora.

Avant de commencer

Avant d'utiliser le connecteur Zuora, 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 en savoir plus, 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.

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.

      Les régions disponibles pour les connecteurs sont les suivantes :

      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 Zuora 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.
    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. (Facultatif) Configurez les paramètres des 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.

    8. Locataire : indiquez votre locataire Zuora. Par défaut, nous utilisons le locataire "USProduction".
    9. URL : requise uniquement si vous disposez d'un environnement de copie de production aux États-Unis. Si cette propriété est fournie, la valeur de la propriété "Locataire" n'a aucun effet sur le processus d'authentification.
    10. Service Zuora : spécifie le service d'exécution ou le schéma à utiliser.
    11. Utiliser la pagination côté client : indique si le fournisseur CData ADO.NET pour SAP Cloud for Customer doit utiliser la pagination côté client.
    12. Utiliser un service personnalisé : indique si le service OData SAP Cloud for Customer personnalisé doit être utilisé.
    13. Vues définies par l'utilisateur : chemin d'accès à un fichier de configuration JSON contenant vos vues personnalisées.
    14. (Facultatif) Cliquez sur + Ajouter une étiquette pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
    15. Cliquez sur Suivant.
  5. 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 Zuora :

      • Identifiants client OAuth2

      2. Pour savoir comment configurer ces types d'authentification, consultez Configurer l'authentification.

    2. Cliquez sur Suivant.
  6. Vérifier : vérifiez vos informations de connexion et d'authentification.
  7. Cliquez sur Créer.

Configurer l'authentification

Pour activer l'authentification à l'aide d'identifiants client OAuth 2.0, procédez comme suit :

  1. Créez des identifiants client dans Zuora, et obtenez l'ID client et le code secret du client.
  2. Spécifiez les identifiants dans Google Cloud.

Créer des identifiants client dans Zuora

  1. Sur le portail OneID, cliquez sur votre avatar, puis sur Settings (Paramètres).
  2. Cliquez sur Manage OAuth 2.0 Clients (Gérer les clients OAuth 2.0).
  3. Sur la page Manage OAuth 2.0 Clients (Gérer les clients OAuth 2.0), cliquez sur New (Nouveau).
  4. Dans la fenêtre New OAuth 2.0 Client (Nouveau client OAuth 2.0), renseignez les champs suivants :
    • Name (Nom) : saisissez le nom du client.
    • Type : sélectionnez Client Credentials (Identifiants client) dans la liste.
  5. Cliquez sur Save (Enregistrer). Une fois le client créé, une fenêtre contenant l'ID client et le code secret du client s'affiche.

    Enregistrez l'ID client et le code secret du client pour utilisation ultérieure. Pour en savoir plus, consultez Manage OAuth 2.0 clients (Gérer les clients OAuth 2.0).

Spécifier les identifiants dans Google Cloud

Lorsque vous créez la connexion dans Integration Connectors, vous devez spécifier les informations suivantes :

Dans la section Authentification, saisissez les informations suivantes :

  • ID client : ID client de l'application que vous avez créée
  • Code secret du client : secret Secret Manager contenant le code secret du client pour l'application connectée que vous avez créée

Type de connexion Web

Le tableau suivant présente des exemples de valeurs de configuration pour le type de connexion Web Zuora :

Nom du champ Détails
Emplacement us-central1
Connecteur Zuora
Version du connecteur 1
Nom de connexion zuora-con
Compte de service account@my-project.iam.gserviceaccount.com
Locataire TENANT
Nombre minimal de nœuds 2
Nombre maximal de nœuds 4
ID client CLIENT_ID
Code secret du client SECRET_CLIENT
Version du secret 1

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.

Exemples d'opérations d'entité

Cette section explique comment effectuer certaines opérations d'entité dans ce connecteur.

Exemple : Lister tous les enregistrements dans "Refunds"

Cet exemple liste tous les enregistrements de l'entité Refunds.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Refunds dans la liste Entity.
  3. Sélectionnez l'opération List, puis cliquez sur OK.
  4. (Facultatif) Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre.

Exemple : Récupérer un enregistrement de note de débit

Cet exemple récupère un enregistrement dont l'ID est 45 à partir de l'entité Debit_Memo.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Debit_Memo dans la liste Entity.
  3. Sélectionnez l'opération Get, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez 45 dans le champ Valeur par défaut.

    Ici, 45 est une valeur de clé primaire dans l'entité Debit_Memo.

Exemple : Créer une demande

Cet exemple crée une demande dans l'entité Ticket.

  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 : 
    {
"Name": "Test735362767",
"Label": "Test735362767",
"Type": "String",
"FieldType": "Insert ticket1",
"GroupName": "ticketinformation",
"Description": "Test ticket"
}

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

    {
"Name": "Test1695971640609"
}

Exemple : Mettre à jour une entrée de transaction

Cet exemple met à jour l'enregistrement dont l'ID est 97 dans l'entité Deals.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Deals 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": "New description"
}
  5. Cliquez sur entityId, puis saisissez 97 dans le champ Valeur par défaut.

    Sinon, au lieu de spécifier entityId, vous pouvez définir filterClause sur 97.

Exemple : Supprimer un formulaire

Cet exemple supprime l'enregistrement dont l'ID est 78 dans l'entité Forms.

  1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
  2. Sélectionnez Forms dans la liste Entity.
  3. Sélectionnez l'opération Delete, puis cliquez sur OK.
  4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 78 dans le champ Valeur par défaut.

Créer des connexions à l'aide de Terraform

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
tenant ENUM False Indiquez le nom de votre locataire Zuora. Par défaut, nous utilisons le locataire "USProduction". Valeurs acceptées : "USProduction", "USAPISandbox", "USPerformanceTest", "EUProduction", "EUSandbox", "EUCentralSandbox", "USCloudProduction", "USCloudAPISandbox" et "USCentralSandbox".
URL STRING False Cette valeur est requise uniquement si vous disposez d'un environnement de copie de production aux États-Unis. Si cette propriété est fournie, la valeur de la propriété "Locataire" n'a aucun effet sur le processus d'authentification.
zuora_service ENUM False Spécifie le service d'exécution ou le schéma à utiliser. Valeurs acceptées : "DataQuery" et "AQuADataExport".
use_client_side_paging BOOLÉEN False Indique si le fournisseur CData ADO.NET pour SAP Cloud for Customer doit utiliser la pagination côté client.
use_custom_service BOOLEAN False Indique si le service OData SAP Cloud for Customer personnalisé doit être utilisé.
user_defined_views STRING False Chemin d'accès à un fichier de configuration JSON contenant vos vues personnalisées.

Utiliser la connexion Zuora 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