FreshBooks

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

Versions compatibles

Ce connecteur modélise l'API FreshBooks Alpha en tant qu'objets de base de données pouvant être interrogés avec SQL.

Avant de commencer

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

Pour en savoir plus sur la création d'une application et la génération d'un identifiant et d'un code secret de client pour l'authentification, consultez Get Started with FreshBooks API (Premiers pas avec l'API FreshBooks).

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 Freshbooks 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. ID de compte : ID du compte auquel se connecter. Si aucune valeur n'est spécifiée, la première valeur renvoyée est utilisée.
   9. (Facultatif) Cliquez sur + Ajouter une étiquette pour ajouter une étiquette à la connexion sous la forme d'une paire clé/valeur.
   10. 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 Freshbooks :

      • Attribution de code d'autorisation OAuth 2.0

   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

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

• Attribution de code d'autorisation OAuth 2.0
  • Niveaux d'accès : liste des niveaux d'accès souhaités, séparés par une virgule
  • ID client : ID client utilisé pour demander des jetons d'accès
  • Code secret du client : code secret du client utilisé pour demander des jetons d'accès

Pour autoriser la connexion FreshBooks, procédez comme suit :

1. Sur la page Connexions, cliquez sur la connexion FreshBooks.
2. Dans la section Authentification, cliquez sur Autoriser la connexion.
3. Accédez à la section URI de redirection, puis copiez-le.
4. Dans l'application FreshBooks, cliquez sur Redirect URIs (URI de redirection).
5. Collez l'URI de redirection que vous avez copié à partir de la connexion FreshBooks, puis cliquez sur Save Settings (Enregistrer les paramètres).
6. Revenez à la connexion FreshBooks, puis cliquez sur Autoriser dans la section d'authentification.

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

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.

Exemples d'opérations d'entité

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

Exemple : Lister tous les projets

Cet exemple liste tous les projets de l'entité Projects.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Projects 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 à partir d'une entité

Cet exemple récupère un enregistrement dont l'ID est 2009015 à partir de l'entité Expense Categories.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Expense Categories 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 2009015 dans le champ Valeur par défaut.

   Ici, 2009015 est une valeur de clé primaire dans l'entité Expense Categories.

Exemple : Créer une facture

Cet exemple crée une facture 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 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 :

   {"CustomerId": 68039.0,
   "FirstName": "John",
   "CreateDate": "2023-09-13"
   }

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

   {
   "Id": "49594.0"
   }

Exemple : Mettre à jour une facture

Cet exemple met à jour la facture dont l'ID est 36741.0 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 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 :

   {
   "FirstName": "James"
   }

5. Cliquez sur entityId, puis saisissez 36741.0 dans le champ Valeur par défaut.

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

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

   {
   "Id": "36741.0"
   }

Exemple : Supprimer un enregistrement

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

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Payments 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
account_id	CHAÎNE	True	ID du compte auquel se connecter. Si aucune valeur n'est spécifiée, la première valeur renvoyée est utilisée.

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

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