OpenAPI

OpenAPI est pour décrire les API REST. En utilisant Spécification OpenAPI 2.0, vous pouvez créer des documents OpenAPI pour Business Messages et Business API de communication pour décrire leur structure.

Vous pouvez ainsi effectuer les opérations suivantes :

• Créer des bibliothèques clientes dans le langage de votre choix
• Créer des bouchons de serveur
• Utiliser des outils de gestion des API

Structure de base d'un document OpenAPI

Un document OpenAPI décrit la surface d'une API REST. Ce document définit le nom et la description de l'API, les points de terminaison individuels (chemins d'accès) dans l'API, la méthode d'authentification des appelants, etc.

Cliquez ci-dessous pour afficher un exemple de cette structure de base.

JSON

    {
      "swagger": "2.0",
      "host": "businessmessages.googleapis.com",
      "info": {
        "title": "Business Messages API",
        "description": "",
        "version": "v1"
      },
      "paths": {
        "/v1/conversations/{conversationsId}/messages": {
          "post": {
            "description": "Sends a message from an agent to a user.",
            "parameters": [
              {
                "description": "Part of `parent`. Required. The conversation that contains the message. Resolves to \"conversations/{conversationId}\".",
                "type": "string",
                "in": "path",
                "required": true,
                "name": "conversationsId"
              },
              {
                "description": "Optional. A flag to send the specified fallback text instead of other message content.",
                "name": "forceFallback",
                "type": "boolean",
                "in": "query"
              },
              {
                "name": "message",
                "schema": {
                  "$ref": "#/definitions/BusinessMessagesMessage"
                },
                "in": "body",
                "description": "Required. The content of a message."
              }
            ],
            "tags": [
              "businessmessages"
            ],
            "operationId": "CreateMessage",
            "responses": {
              "default": {
                "schema": {
                  "$ref": "#/definitions/BusinessMessagesMessage"
                },
                "description": "Successful operation"
              }
            }
          }
        }
      }
    }
    

Pour en savoir plus sur la structure d'un document OpenAPI, consultez la Site Web Swagger :

Accéder aux documents OpenAPI

Pour accéder aux documents OpenAPI, vous devez disposer d'une clé API provenant d'un serveur Projet de plate-forme GCP (GCP) avec Business Messages et Business Communications API activées.

Suivez les sections ci-dessous pour

• créer un projet GCP
• créer une clé API
• activer les API Business Messages et Business Communications

Une fois ces étapes terminées, vous pouvez accéder aux documents OpenAPI.

Créer un projet GCP

Si vous disposez déjà d'un projet GCP, vous pouvez l'utiliser pour créer une clé API.

Pour créer un projet GCP, procédez comme suit:

1. Accédez à la page Gérer les ressources. de la console GCP.
2. Dans la liste déroulante Sélectionner une organisation en haut de la page, sélectionnez l'organisation pour laquelle vous souhaitez créer le projet. Si vous bénéficiez d'un essai sans frais, ignorez cette étape.
3. Cliquez sur Créer un projet.
4. Dans la fenêtre New Project (Nouveau projet), saisissez un nom de projet et sélectionnez un compte de facturation, selon le cas. Le nom d'un projet ne peut contenir que des lettres, des chiffres, guillemets, traits d'union, espaces ou points d'exclamation, et doit comporter entre 4 et 30 caractères.

5. Dans le champ Emplacement, indiquez l'organisation ou le dossier parent du nouveau projet.

6. Cliquez sur Créer.

Créer une clé API

1. Accédez au Page "Identifiants" dans la console GCP.

2. Cliquez sur Créer les identifiants, puis sélectionnez Clé API.

   La boîte de dialogue Clé API créée affiche la nouvelle clé. Copiez votre clé et conservez-la en lieu sûr. Pour en savoir plus sur les clés API, consultez la Documentation sur les clés API

Activer les API Business Communications et Business Messages

Pour activer ces API dans votre projet GCP, procédez comme suit:

1. Accédez à la page API et Services de la console GCP.
2. Dans la liste déroulante Sélectionner un projet, sélectionnez projet pour lequel vous souhaitez activer les API.
3. Cliquez sur Activer les API et les services.
4. Dans le champ Rechercher des API et des services, saisissez Business Messages.
5. Sélectionnez API Business Messages.
6. Cliquez sur Activer.
7. Cliquez sur Activer les API et les services.
8. Dans le champ Rechercher des API et des services, saisissez Business Communications.
9. Sélectionnez API Business Communications.
10. Cliquez sur Activer.

Votre clé API est maintenant autorisée à accéder aux documents OpenAPI pour la API Business Messages et Business Communications.

Accéder aux documents OpenAPI

Exécutez la commande suivante pour accéder au document OpenAPI de l'API Business Messages:

curl "https://businessmessages.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

Exécutez la commande suivante pour accéder au document OpenAPI de l'API Business Communications:

curl "https://businesscommunications.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"

Remplacez API_KEY par votre clé API.