ZohoBooks

Le connecteur ZohoBooks vous permet d'effectuer des opérations SQL sur le système ZohoBooks.

Versions compatibles

Le connecteur exploite l'API Zoho Books V3 pour permettre un accès bidirectionnel aux données Zoho Books.

Avant de commencer

Avant d'utiliser le connecteur ZohoBooks, 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.

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 :

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"
Cliquez sur + Créer pour ouvrir la page Créer une connexion.
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.
Dans la section Détails de la connexion, procédez comme suit :
1. Connecteur : sélectionnez ZohoBooks 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 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.
8. Serveur de comptes : URL complète du serveur de comptes.
9. ID de l'organisation : ID associé à une organisation Zoho Books spécifique.
10. Niveau de verbosité : niveau de verbosité de la connexion (de 1 à 5). Un niveau de verbosité plus élevé consigne tous les détails de la communication (requête, réponse et certificats SSL).
11. (Facultatif) Cliquez sur + Ajouter une étiquette pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
12. Cliquez sur Suivant.
Dans la section Authentification, saisissez les informations d'authentification.
1. Sélectionnez un type d'authentification, puis saisissez les informations appropriées.
  Le type d'authentification suivant est compatible avec la connexion Zoho Books :
  - Attribution de code d'autorisation OAuth 2.0
2. Cliquez sur Suivant.
Vérifier : vérifiez vos informations de connexion et d'authentification.
Cliquez sur Créer.

Configurer l'authentification

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

Attribution de code d'autorisation OAuth 2.0
- ID client : ID client fourni par le connecteur pour 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.
- Jeton d'accès : secret Secret Manager contenant le jeton d'accès OAuth fourni pour l'application connectée que vous avez créée.

Configurer l'authentification ZohoBooks

Les sections suivantes expliquent comment configurer le connecteur ZohoBooks.

Configurer un compte ZohoBooks

Pour en savoir plus sur la configuration du compte ZohoBooks, consultez Account creation (Création d'un compte).

Configurer un compte de développeur et créer une application cliente

Pour en savoir plus sur la création d'un compte de développeur et d'une application cliente ZohoBooks, consultez Client App creation (Création d'une application cliente).

Configurer l'authentification

Pour configurer l'authentification, procédez comme suit :

Dans la console Cloud, accédez à la page Connecteurs d'intégration.
Pour afficher les détails d'une connexion spécifique, cliquez sur le nom d'une connexion dans le tableau des connexions existantes.
Dans la section Authentification, cliquez sur Autoriser la connexion pour lancer le processus d'autorisation.
Copiez l'URI de redirection.
Accédez à la console développeur ZohoBooks.
Dans la section de l'URI de redirection autorisé du client de l'application basée sur un service, ajoutez l'URI de redirection.
Sur la page Integration Connectors, accédez à la page de connexion ZohoBooks à partir de laquelle vous avez copié l'URI de redirection, puis cliquez sur Authorize (Autoriser).

Vous êtes redirigé vers le site ZohoBooks pour donner votre autorisation.

Exemples de configuration de connexion

Cette section présente des exemples de valeurs pour les différents champs que vous configurez lorsque vous créez la connexion Zoho Books.

Type de connexion Web

Nom du champ	Détails
Région	us-east4
Connecteur	ZohoBooks
Version du connecteur	1
Nom de connexion	zohobooks-google-cloud-conn
Compte de service	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Serveur de comptes	https://books.zoho.in
ID de l'organisation	ID_ORGANISATION
Verbosité	5
Nombre minimal de nœuds	2
Nombre maximal de nœuds	50
ID client	ID_CLIENT
Niveaux d'accès	ZohoBooks.fullaccess.all
Code secret du client	SECRET_CLIENT
Version du secret	1

Utiliser la connexion ZohoBooks 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".

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 :
- List
- Get
- Create
- Update
- Delete
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.

Actions

Cette section présente certaines des actions prises en charge par la connexion Zoho Books. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Remarque : Les résultats de toutes les actions seront disponibles sous forme de réponse JSON dans le paramètre de réponse connectorOutputPayload de la tâche Connectors une fois l'intégration exécutée.

Action ImportCreditCardStatement

Cette action permet d'importer des relevés de carte de crédit.

Paramètres d'entrée de l'action ImportCreditCardStatement

Nom du paramètre	Type de données	Obligatoire	Description
AccountId	STRING	Non	ID du compte bancaire/de carte de crédit.
TransactionsTransactionDebitOrCredit	STRING	Non	Indique si la transaction est un débit ou un crédit.
TransactionsTransactionAmount	STRING	Non	Montant de la transaction.
TransactionsTransactionDescription	STRING	Non	Description de la transaction.
TransactionsTransactionDate	STRING	Non	Date de la transaction.

Pour savoir comment configurer l'action ImportCreditCardStatement, consultez Exemples.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Importer un relevé de carte de crédit

Cet exemple importe un relevé de carte de crédit.

Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
Sélectionnez l'action ImportCreditCardStatement, puis cliquez sur OK.

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 :

{
  "AccountId": "1470449000000023015",
  "TransactionsTransactionDebitOrCredit": "credit",
  "TransactionsTransactionAmount": "200",
  "TransactionsTransactionDescription": "Transaction done from Google account",
  "TransactionsTransactionDate": "2023-05-05"
}

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

[{
"Status": "Your bank statement has been imported."
}]

Exemples d'opérations d'entité

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

Exemple : Lister toutes les estimations

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

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Estimates dans la liste Entity.
Sélectionnez l'opération List, puis cliquez sur OK.
(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. Vous pouvez également spécifier plusieurs conditions de filtre à l'aide des opérateurs logiques.

Exemple : Récupérer un bon de commande

Cet exemple récupère le bon de commande spécifié à partir de l'entité SalesOrder.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez SalesOrder dans la liste Entity.
Sélectionnez l'opération Get, puis cliquez sur OK.
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez 1470449000000043003 dans le champ Valeur par défaut.
Ici, 1470449000000043003 est une valeur de clé primaire dans l'entité SalesOrder.

Exemple : Créer une transaction bancaire

Cet exemple crée un enregistrement de transaction bancaire dans l'entité BankTransactions.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez BankTransactions dans la liste Entity.
Sélectionnez l'opération Create, puis cliquez sur OK.
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 :
```
{
"TransactionType": "transfer_fund",
"FromAccountId": "1470449000000000459",
"ToAccountId": "1470449000000110001",
"Amount": 45.0,
"CurrencyId": "1470449000000000064"
}
```
Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :
```
{
"TransactionId": "1470449000000231005"
}
```

Exemple : Mettre à jour les coordonnées du client

Cet exemple met à jour l'enregistrement client spécifié dans l'entité CustomerContacts.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez CustomerContacts dans la liste Entity.
Sélectionnez l'opération Update, puis cliquez sur OK.
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 :
```
{
"Department": "Development",
"ContactId": "1470449000000038003"
}
```
Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 1470449000000038005 dans le champ Valeur par défaut.

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

{
"CustomerContactId": "1470449000000038005"
}

Exemple : Supprimer un enregistrement de facture

Cet exemple supprime l'enregistrement de facture spécifié dans l'entité InvoiceDetails.

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

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

Découvrez comment suspendre et reprendre une connexion.
Découvrez comment surveiller l'utilisation des connecteurs.
Découvrez comment afficher les journaux des connecteurs.