Cette page a été traduite par l'API Cloud Translation.

Box

Le connecteur Box vous permet de vous connecter à un backend Box et d'utiliser SQL pour récupérer et mettre à jour les données Box.

Versions compatibles

Ce connecteur est compatible avec la version 2.0 de l'API Box Content.

Avant de commencer

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

Dans votre projet Google Cloud :
- Accorder à l'utilisateur le rôle IAM roles/connectors.admin configuration du 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 :

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"
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.
  Pour obtenir la liste de toutes les régions disponibles, consultez la page Emplacements.
2. Cliquez sur NEXT (Suivant).
Dans la section Détails de connexion, procédez comme suit :
1. Connecteur : sélectionnez Box 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 peuvent pas dépasser 63 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.
7. Mode d'emprunt d'identité : spécifiez le type d'emprunt d'identité. Il doit s'agir du mode utilisateur ou du mode administrateur.
8. Utiliser un proxy : cochez cette case pour configurer un serveur proxy pour la connexion, et spécifiez les valeurs suivantes :
9. Vous pouvez également cliquer sur + AJOUTER UN LIBELLÉ pour ajouter un libellé à la connexion sous la forme d'une paire clé/valeur.
10. Cliquez sur NEXT (Suivant).
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 Box :
  - OAuth 2.0 - Identifiants client
  - OAuth 2.0 - Code d'autorisation
2. Cliquez sur NEXT (Suivant).
Vérifiez vos informations de connexion et d'authentification.
Cliquez sur Créer.

Configurer l'authentification

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

OAuth 2.0 - Identifiants client
- 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 client pour l'application connectée que vous avez créée.
- Clé privée : secret Secret Manager contenant le contenu du fichier de clé privée. La clé privée doit correspondre à la clé publique/au certificat fournis au connecteur.
- Mot de passe de la clé privée : secret Secret Manager contenant le mot de passe (paraphrase) du fichier de clé privée.
- Niveau d'accès de l'application Box : niveau d'accès de l'application Box.
- ID d'entreprise/ID d'utilisateur : ID d'entreprise si le niveau de l'application est "Enterprise" et ID d'utilisateur si le niveau d'application est "User".
- ID de clé publique JWT OAuth : ID de la clé publique pour JWT.
- Schéma d'authentification : schéma d'authentification pour le connecteur Box.
- Initier OAuth : initier le paramètre OAuth pour le connecteur Box
- Type de certification JWT OAuth : type de certification JWT OAuth pour le connecteur Box.
OAuth 2.0 - Code d'autorisation

ID client : ID client fourni par votre application externe.
Champs d'application : champs d'application d'autorisation. Par exemple, root_readonly. Pour comprendre le fonctionnement des niveaux d'accès et pour afficher tous les champs d'application disponibles pour Box consultez la section Champs d'application.
Secret du client : sélectionnez le secret Secret Manager. Vous devez avoir créé le secret Secret Manager avant de configurer cette autorisation.
Version du secret : version du secret Secret Manager pour le code secret du client.

Pour le type d'authentification Authorization code, après avoir créé la connexion, vous doit effectuer quelques étapes supplémentaires pour configurer l'authentification. Pour plus d'informations, consultez la section Étapes supplémentaires après la création d'une connexion.

Remarque : Si vous utilisez le type d'authentification Authorization code et que vous avez modifié la configuration de votre application Box, vous devez autoriser à nouveau votre connexion Box. Pour comprendre comment effectuer une nouvelle autorisation, consultez la section Effectuer une nouvelle autorisation au code d'autorisation.

Étapes supplémentaires après la création de la connexion

Si vous avez sélectionné OAuth 2.0 - Authorization code pour vous devez effectuer les étapes supplémentaires suivantes après avoir créé la connexion:

Sur la page Connexions : localisez la connexion qui vient d'être créée.
Notez que l'état du nouveau connecteur sera Autorisation requise.
Cliquez sur Autorisation requise.
Le volet Modifier l'autorisation s'affiche.
Copiez la valeur Redirect URI (URI de redirection) dans votre application externe.
Vérifiez les détails de l'autorisation.
Cliquez sur Autoriser.
Si l'autorisation aboutit, l'état de la connexion est défini sur Active (Actif) dans la Page "Connexions".

Nouvelle autorisation pour le code d'autorisation

Si vous utilisez le type d'authentification Authorization code et que vous avez modifié la configuration de votre application Box, vous devez autoriser à nouveau votre connexion Box. Pour autoriser à nouveau une connexion, procédez comme suit:

Cliquez sur la connexion requise sur la page Connexions.
La page "Détails de la connexion" s'ouvre.
Cliquez sur Edit (Modifier) pour modifier les détails de la connexion.
Vérifiez les détails du code d'autorisation OAuth 2.0 dans la section Authentification.
Si nécessaire, apportez les modifications nécessaires.
Cliquez sur Enregistrer. La page des détails de la connexion s'affiche.
Cliquez sur Modifier l'autorisation dans la section Authentification. Le volet Autoriser s'affiche.
Cliquez sur Autoriser.
Si l'autorisation aboutit, l'état de la connexion est défini sur Active (Actif) 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 via 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é. 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é, d'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 une sortie . Toutefois, il est possible qu'un connecteur ne prenne en charge aucune action, auquel cas la liste Actions est vide.

Actions

Cette section liste toutes les actions compatibles avec la connexion Box.

Action DownloadFile

Cette action vous permet de télécharger un fichier à partir de votre instance Box.

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

Nom du paramètre	Type de données	Obligatoire	Description
FileID	Chaîne	Oui	ID du fichier à télécharger.
HasBytes	Booléen	Oui	Indique si le fichier doit être téléchargé sous forme de chaîne ou de chaîne encodée en base64.

Paramètres de sortie de l'action DownloadFile

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Nom du paramètre	Type de données	Description
Opération réussie	Chaîne	Indique si le fichier fhe a bien été téléchargé.
ContentBytes	Chaîne	Contenu du fichier sous forme de chaîne encodée en base64.

Par exemple, pour configurer l'action DownloadFile, consultez les exemples d'actions.

Action UploadFile

Cette action vous permet d'importer un fichier sur votre instance Box.

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

Nom du paramètre	Type de données	Obligatoire	Description
ParentID	Chaîne	Oui	ID du dossier dans lequel vous souhaitez importer le fichier. Si ce paramètre n'est pas spécifié, le fichier sera importé à la racine du compte Box. La valeur par défaut est 0.
Contenu	Chaîne	Oui	Contenu du fichier à importer.

Paramètres de sortie de l'action UploadFile

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Nom du paramètre	Type de données	Description
Opération réussie	Chaîne	Indique si le fichier fhe a bien été importé.
ID	Chaîne	ID du fichier que vous venez de créer.
VersionID	Chaîne	ID d'une version spécifique du fichier.
Hachage	Chaîne	Le hachage `SHA1` du fichier.
ETag	Chaîne	Valeur Etag du fichier ou du dossier. La valeur par défaut est 0.

Par exemple, pour configurer l'action UploadFile, consultez les exemples d'actions.

Action CopyFile

Cette action vous permet de copier un fichier à partir de votre instance Box.

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

Nom du paramètre	Type de données	Obligatoire	Description
FileID	Chaîne	Oui	ID du fichier que vous souhaitez copier.
DestinationFolderId	Chaîne	Non	ID du dossier de destination dans lequel vous souhaitez copier le fichier. Si vous ne spécifiez pas n'importe quelle valeur, la dernière version du fichier est copiée.
NewName	Chaîne	Oui	Nouveau nom du fichier copié.

Paramètres de sortie de l'action CopyFile

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Nom du paramètre	Type de données	Description
Opération réussie	Chaîne	Indique si le fichier fhe a bien été copié.
ID	Chaîne	ID du fichier copié.

Par exemple, pour configurer l'action CopyFile, consultez les exemples d'actions.

Action CopyFolder

Cette action vous permet de copier un dossier entier à partir de votre instance Box.

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

Nom du paramètre	Type de données	Obligatoire	Description
FolderID	Chaîne	Oui	ID du dossier que vous souhaitez copier.
DestinationFolderId	Chaîne	Oui	ID du dossier de destination dans lequel vous souhaitez copier le dossier.
NewName	Chaîne	Non	Nouveau nom de fichier pour le dossier copié.

Paramètres de sortie de l'action CopyFolder

Cette action renvoie l'état 200 (OK) avec un corps de réponse indiquant les résultats.

Nom du paramètre	Type de données	Description
Opération réussie	Chaîne	Indique si le dossier a bien été copié.
ID	Chaîne	ID du dossier copié.

Par exemple, pour configurer l'action CopyFolder, consultez les exemples d'actions.

Exemples d'actions

Cette section décrit comment effectuer certaines actions dans ce connecteur.

Exemple : Télécharger un fichier

Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
Sélectionnez l'action DownloadFile, puis cliquez sur OK.
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 à celle-ci dans la section Champ Default Value:
```
{
"FileID": "1283194869422", 
"HasBytes": true
}
```

Cet exemple télécharge un fichier sous forme de chaîne encodée en base64. Si l'action aboutit, votre Réponse connectorOutputPayload de la tâche de connecteur aura une valeur semblable à celle-ci:

[
{ "Success": "True"},
{"ContentBytes": "JVBERi0xLjQKJcfl9OXwCjIgMCBvYmoKJSBbMjRdIAo8PAovRmlsdGVy"}
]

Remarque : Si vous souhaitez télécharger un fichier non binaire, définissez la valeur HasBytes à false.

Exemple : Importer un fichier

Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
Sélectionnez l'action UploadFile, puis cliquez sur OK.
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 à celle-ci dans la section Champ Default Value:
```
{
"ParentId": "0",
"Content": "12345"
}
```

Cet exemple importe le contenu de chaîne sous forme de fichier. Si l'action aboutit, votre Réponse connectorOutputPayload de la tâche de connecteur aura une valeur semblable à celle-ci:

[{
"Success": "true",
"ID": "1283902965389",
"VersionID": "1403546001389",
"Hash": "8cb2237d0679ca88db6464eac60da96345513964",
"Etag": "0"
}]

Exemple : Copier un fichier

Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
Sélectionnez l'action CopyFile, puis cliquez sur OK.
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 à celle-ci dans la section Champ Default Value:
```
{
"FileID": "1288751886061",
"DestinationFolderId": "219105724517", 
"NewName": "NewCopiedFile"
}
```

Cet exemple copie le fichier portant l'ID 1288751886061 dans le dossier portant l'ID 219105724517. Si l'action aboutit, votre Réponse connectorOutputPayload de la tâche de connecteur aura une valeur semblable à celle-ci:

[{
"Success": "true",
"ID": "1308006018536"
}]

Exemple : Copier un dossier

Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
Sélectionnez l'action CopyFolder, puis cliquez sur OK.
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 à celle-ci dans la section Champ Default Value:
```
{
"FolderID": "218475301279",
"DestinationFolderId": "0", 
"NewName": "NewCopiedFolder"
}
```

Cet exemple copie le dossier portant l'ID 218475301279. dans le dossier portant l'ID 219105724517. Si l'action aboutit, votre Réponse connectorOutputPayload de la tâche de connecteur aura une valeur semblable à celle-ci:

[{
"Success": "true",
"ID": "226312444517"
}]

Exemples d'opérations sur les entités

Exemple : Répertorier tous les fichiers

Cet exemple répertorie les fichiers de l'entité Files.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Files dans la liste Entity.
Sélectionnez l'opération LIST, puis cliquez sur OK.
Vous pouvez éventuellement saisir des valeurs dans filterClause pour filtrer l'ensemble de résultats.

Exemple – Achat d'un billet

Cet exemple récupère un ticket spécifique de l'entité Tickets.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Tickets dans la liste Entity.
Sélectionnez l'opération GET, puis cliquez sur OK.
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 35 dans le champ Default Value (Valeur par défaut).
Ici, 35 est la valeur de clé primaire de l'entité Tickets.

Exemple : Créer une demande d'assistance

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

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez Tickets dans la liste Entity.
Sélectionnez l'opération Create, puis cliquez sur OK.

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 à celle-ci dans la section Champ Default Value:

{
"Subject": "Create_Ticket_01",
"Description": "Test",
"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
}

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

{
"Id": 38.0
}

Exemple – Mettre à jour une demande

Cet exemple met à jour la demande spécifiée dans l'entité Tickets.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez "Tickets" dans la liste Entity.
Sélectionnez l'opération Update, puis cliquez sur OK.
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 à celle-ci dans la section Champ Default Value:
```
{
        "Subject": "Update_Ticket_02",
        "Description": "Updating the ticket",
        "RequesterId": 1.6854335860497E13
      }
      
```
Cliquez sur entityId, puis saisissez 35 dans le champ Valeur par défaut.
Au lieu de spécifier entityId, vous pouvez également définir le filterClause sur 35.

Si l'intégration réussit, le champ connectorOutputPayload de la tâche de connecteur comporte un semblable à celle-ci:
```
{
Id": 35.0
}
      
```

Exemple : Supprimer un billet

Cet exemple supprime le billet spécifié de l'entité Tickets.

Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
Sélectionnez "Tickets" dans la liste Entity.
Sélectionnez l'opération Delete, puis cliquez sur OK.
Dans la section Task Input (Entrée de la tâche) de la tâche Connectors (Connecteurs), cliquez sur entityId et puis saisissez 35 dans le champ Default Value (Valeur par défaut).

Remarque : L'opération Delete n'effectue qu'une suppression réversible enregistrer. Si nécessaire, vous pouvez récupérer ultérieurement l'enregistrement supprimé.

Utiliser Terraform pour créer des connexions

Vous pouvez utiliser l'outil Terraform ressource pour créer une connexion.

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

Pour afficher un exemple de modèle Terraform pour la création de connexions, consultez cet 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	Requis	Description
impersonate_user_mode	ENUM	Vrai	Spécifiez le type d'emprunt d'identité de l'utilisateur. Il doit s'agir du mode utilisateur ou du mode administrateur. Valeurs acceptées: User, Admin
proxy_enabled	VALEUR BOOLÉENNE	Faux	Cochez cette case pour configurer un serveur proxy pour la connexion.
proxy_auth_scheme	ENUM	Faux	Type d'authentification à utiliser pour s'authentifier auprès du proxy ProxyServer. Les valeurs acceptées sont: BASIC, DIGEST, NONE
proxy_user	STRING	Faux	Nom d'utilisateur permettant de s'authentifier auprès du proxy ProxyServer.
proxy_password	SECRET	Faux	Mot de passe à utiliser pour l'authentification auprès du proxy ProxyServer.
proxy_ssltype	ENUM	Faux	Type SSL à utiliser lors de la connexion au proxy ProxyServer. Les valeurs acceptées sont: AUTO, ALWAYS, NEVER et TUNNEL.

Utiliser la connexion Box dans une intégration

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

Pour comprendre 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.

Obtenir de l'aide auprès de la communauté Google Cloud

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

Étape suivante

Découvrez comment suspendre et réactiver une connexion.
Découvrez comment surveiller l'utilisation des connecteurs.
Découvrez comment afficher les journaux du connecteur.