QuickBooks Online

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

Avant de commencer

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

• Dans votre projet Google Cloud :
  • 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 compte Google spécial 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 la section 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 la page Activer des services.

  Si ces services ou autorisations n'ont pas encore été activés pour votre projet, vous êtes invité à les activer lors de la configuration du connecteur.

Configurer le connecteur

Pour configurer le connecteur, vous devez créer une connexion à votre source de données (système backend). Une connexion est spécifique à 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 Integration Connectors > Connections (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 la page Emplacements.

   2. Cliquez sur NEXT (Suivant).
4. Dans la section Détails de connexion, procédez comme suit :
   1. Connecteur: sélectionnez QuickBooks 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, saisissez un nom pour l'instance de connexion.

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

      • Les noms de connexion peuvent contenir des lettres, des chiffres ou des traits d'union.
      • Les lettres doivent être en minuscules.
      • Les noms de connexion doivent commencer par une lettre et se terminer par une lettre ou un chiffre.
      • Les noms de connexion ne doivent pas dépasser 49 caractères.
   4. Saisissez éventuellement une Description pour l'instance de connexion.
   5. Compte de service : sélectionnez un compte de service disposant des rôles requis.
   6. Vous pouvez également configurer les paramètres du nœud 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 plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, moins de nœuds sont nécessaires pour traiter moins de transactions. Pour comprendre comment les nœuds affectent la tarification de votre connecteur, consultez la section 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 une meilleure disponibilité) et le nombre maximal sur 50.

   Remarque : Vous ne pouvez personnaliser les valeurs du nœud de connexion que si vous êtes un client facturé à l'usage.
   7. Company Id (ID de l'entreprise) : indiquez l'identifiant de l'entreprise de l'application enregistrée sur le portail des développeurs Intuit.
   8. Si vous le souhaitez, saisissez un Country Code (Code pays) : correspond à l'édition de QuickBooks Online utilisée.
   9. Si vous le souhaitez, saisissez un Version mineure: à utiliser lors de l'envoi de requêtes à l'API QuickBooks Online.
   10. Utiliser le bac à sable : cochez cette case si vous utilisez un compte de bac à sable.
   11. Utiliser un proxy : cochez cette case pour configurer un serveur proxy pour la connexion, et spécifiez 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 :
     • Basique : authentification HTTP de base.
     • Condensé : authentification HTTP par condensé.
   • Utilisateur du proxy : nom d'utilisateur à utiliser pour l'authentification 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 SSL est toujours activée.
     • Jamais : la connexion n'est pas activée pour SSL.
     • Tunnel : la connexion s'effectue via 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 :

          • Créez un rattachement de service PSC.
          • Créez un rattachement de point de terminaison, puis saisissez les détails du rattachement de point de terminaison dans le champ Adresse de l'hôte.
   12. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
   13. Cliquez sur NEXT (Suivant).
5. Dans la section Destinations, saisissez les informations concernant 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 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 du point de terminaison dans la liste, puis sélectionnez le rattachement du point de terminaison requis dans la liste Rattachement du point de terminaison.
        Remarque : Pour savoir comment créer un rattachement du point de terminaison, consultez Rattachement de service PSC et Rattachement du point de terminaison. Une fois le rattachement du point de terminaison créé, il apparaît dans la liste Rattachement du 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 NEXT (Suivant).
6. Dans la section Authentification, saisissez les informations d'authentification.
   • Sélectionnez un type d'authentification, puis saisissez les informations appropriées.
   1. ID client : ID client utilisé pour demander des jetons d'accès.
   2. Scopes (Champs d'application) : liste des champs d'application souhaités, séparés par une virgule
   3. Code secret du client : secret Secret Manager contenant le code secret client pour l'application connectée que vous avez créée.
   4. Version: sélectionnez la version dans le menu déroulant et attribuez-la.
   5. Cliquez sur Suivant.
7. Vérifiez vos informations de connexion et d'authentification.
8. Cliquez sur Créer.
9. Cliquez sur Autoriser.

   Si l'autorisation aboutit, l'état de la connexion est défini sur Active sur la page Connexions.

Configurer l'authentification

Saisissez les détails en fonction de l'authentification que vous souhaitez utiliser.

• Nom d'utilisateur et mot de passe
  • Nom d'utilisateur : nom d'utilisateur du connecteur
  • Mot de passe : Secret de Secret Manager contenant le mot de passe associé au connecteur.

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 via cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

Remarque : Vous pouvez afficher les entités, les opérations et les actions d'un connecteur dans la tâche Connecteurs.

• 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é. 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, dans un connecteur de serveur de fichiers, les dossiers sont les entités et, dans un connecteur de système de messagerie, les files d'attente sont les entités.

  Toutefois, il est possible qu'un connecteur ne soit pas compatible 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é. Vous pouvez effectuer l'une des opérations suivantes sur une entité :
  • Liste
  • Obtenir
  • Créer
  • Mettre à jour
  • Supprimer

  La sélection d'une entité dans la liste disponible 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 de connecteur. Toutefois, si un connecteur n'accepte aucune des opérations d'entité, opérations ne sont pas répertoriées dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration via 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 ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Remarque : Toutes les entités et les actions sont associées à un schéma. Par exemple, un schéma d'action contient les détails des paramètres tels que les noms des paramètres et le type de données correspondant. Le schéma (métadonnées) des entités et des actions est récupéré par la connexion à partir de votre backend. Si des mises à jour sont apportées au schéma, elles ne seront pas automatiquement répercutées dans vos connexions existantes. Vous devez actualiser manuellement le schéma. Pour actualiser le schéma d'une connexion, ouvrez la page Détails de la connexion de la connexion, puis cliquez sur Actualisez le schéma de connexion.

Limites du système

Le connecteur QuickBooks Online peut traiter une transaction par seconde, par nœud, et throttles toutes les transactions au-delà de cette limite. Par défaut, Integration Connectors alloue deux nœuds (pour une meilleure disponibilité) à une connexion.

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

Remarque : Le nombre de nœuds de connecteurs d'intégration s'ajustera automatiquement de manière dynamique en fonction de votre utilisation. Toutefois, si vous souhaitez réserver de la capacité pour de grands volumes sans attendre l'autoscaling, vous pouvez ajuster la valeur minimale de nœuds pour une connexion. Pour traiter plus de transactions pour une connexion, plus de nœuds sont nécessaires. À l'inverse, le nombre de nœuds sont requis si une connexion traite moins de transactions. Pour configurer les valeurs du nœud, procédez comme suit :

• Si vous avez opté pour le paiement à l'usage, configurez les valeurs minimale et maximale du nœud sur la page "Modifier la connexion".
• Si vous disposez d'un abonnement client, contactez l'assistance.

Le nombre maximal de transactions qu'un nœud peut gérer dépend de plusieurs facteurs. Par conséquent, avant d'ajuster le nombre minimal de nœuds pour améliorer le débit, nous vous recommandons de vérifier si vos systèmes backend sont configurés de manière optimale pour gérer le trafic requis.

Exemples d'opérations sur les entités

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

Exemple : Répertorier tous les comptes

Cet exemple répertorie toutes les entités Accountsassociated with the Current application of QB Online.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Accounts dans la liste Entity.
3. Sélectionnez l'opération List, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre. Spécifiez toujours la valeur de la clause de filtre entre guillemets simples ('). Par exemple, BillId='25'. Toi Vous pouvez également spécifier plusieurs conditions de filtre à l'aide des opérateurs logiques. Par exemple, BillId='25' and Active=false.

Exemple : Obtenir un enregistrement

Cet exemple récupère un enregistrement avec l'ID spécifié à partir de l'entité Bills.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Bills dans la liste Entity.
3. Sélectionnez l'opération Get, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur EntityId (ID d'entité). puis saisissez 220 dans le champ Default Value (Valeur par défaut).

   Ici, 220 est une valeur de clé primaire dans l'entité Bills.

Exemple : Créer un enregistrement

Cet exemple crée un enregistrement dans l'entité Vendors.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Vendors dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   {
     {
       "Id": "32",
       "SyncToken": "0",
       "MetaData_CreateTime": "2024-04-17 17:13:24.0",
       "MetaData_LastUpdatedTime": "2024-04-24 19:55:23.0",
       "Title": null,
       "GivenName": null,
       "MiddleName": null,
       "FamilyName": null,
       "Suffix": null,
       "DisplayName": "tim Telephone",
       "CompanyName": "tim Telephone",
       "PrintOnCheckName": "tim Telephone",
       "Active": true,
       "PrimaryPhone_FreeFormNumber": "[phone]",
       "AlternatePhone_FreeFormNumber": null,
       "Mobile_FreeFormNumber": null,
       "Fax_FreeFormNumber": null,
       "PrimaryEmailAddr_Address": null,
       "WebAddr_URI": null,
       "BillAddr_Id": "33",
       "BillAddr_Line1": "10 Main St.",
       "BillAddr_Line2": null,
       "BillAddr_Line3": null,
       "BillAddr_Line4": null,
       "BillAddr_Line5": null,
       "BillAddr_City": "Palo Alto",
       "BillAddr_Country": null,
       "BillAddr_CountrySubDivisionCode": "CA",
       "BillAddr_PostalCode": "94303",
       "BillAddr_Lat": "37.445013",
       "BillAddr_Long": "-122.1391443",
       "OtherContactInfo_Type": null,
       "OtherContactInfo_Telephone_FreeFormNumber": null,
       "TaxIdentifier": null,
       "TermRef": "1",
       "TermRef_Name": null,
       "Balance": "0",
       "AcctNum": null,
       "Vendor1099": false,
       "CurrencyRef": "USD",
       "CurrencyRef_Name": "United States Dollar"
     }
   }

   Si l'intégration aboutit, le champ connectorOutputPayload de votre tâche de connecteur aura une valeur semblable à celle-ci :

   {
   { "Id": "64" }
   }

Exemple : Mettre à jour un enregistrement

Cet exemple met à jour l'enregistrement avec l'ID spécifié dans l'entité Purchases.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Teams 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 :

   {
   {
   "PrivateNote": "Update"
   }
   }

5. Cliquez sur entityId, puis saisissez 22 dans le champ Default Value (Valeur par défaut).

   Ici, 22 est une valeur de clé primaire dans l'entité Purchases.

Exemple : Supprimer un enregistrement

Cet exemple supprime l'enregistrement avec l'ID spécifié dans l'entité Invoices.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Invoices dans la liste Entity.
3. Sélectionnez l'opération Delete, puis cliquez sur OK.
4. Cliquez sur entityId, puis saisissez 10 dans le champ Valeur par défaut.

   Ici, 10 est une valeur de clé primaire dans l'entité Purchases.

   Si l'intégration réussit, le champ connectorOutputPayload de votre tâche de connecteur comportera un semblable à celle-ci:

   {
   {Success}
   }

Utiliser la connexion QuickBooks dans une intégration

Une fois la connexion créée, elle devient disponible à la fois dans Apigee Integration et Application Integration. Vous pouvez utiliser la connexion lors d'une intégration via la tâche "Connecteurs".

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