OpenAPI est une spécification permettant de décrire les API REST. La spécification OpenAPI 2.0 vous permet de créer des documents OpenAPI pour les API Business Messages et Business Communications afin de décrire leur structure.
Vous pouvez ainsi:
- Créer des bibliothèques clientes dans le langage de votre choix
- Créer des simulations de serveur
- Utiliser les outils de gestion des API
Structure de base d'un document OpenAPI
Un document OpenAPI décrit la surface d'une API REST. Le document définit le nom et la description de l'API, les points de terminaison individuels (chemins) de l'API, la manière dont les appelants sont authentifiés, 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 le site Web Swagger.
Accéder aux documents OpenAPI
Pour accéder aux documents OpenAPI, vous devez disposer d'une clé API provenant d'un projet Google Cloud Platform (GCP) avec les API Business Messages et Business Communications 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 avez déjà un projet GCP, vous pouvez l'utiliser pour créer une clé API.
Pour créer un projet GCP, procédez comme suit:
- Accédez à la page Gérer les ressources dans la console GCP.
- 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 offert, ignorez cette étape.
- Cliquez sur Créer un projet.
- Dans la fenêtre Nouveau projet, saisissez un nom de projet et sélectionnez un compte de facturation si nécessaire. Un nom de projet ne peut contenir que des lettres, des chiffres, des guillemets simples, des traits d'union, des espaces ou des points d'exclamation. Il doit comporter entre 4 et 30 caractères.
Dans le champ Emplacement, saisissez l'organisation ou le dossier parent du nouveau projet.
Cliquez sur Créer.
Créer une clé API
Accédez à la page Identifiants de la console GCP.
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:
- Accédez à la page API et services de la console GCP.
- Dans la liste déroulante Sélectionner un projet, sélectionnez le projet pour lequel vous souhaitez activer les API.
- Cliquez sur Activer les API et les services.
- Dans le champ Search for APIs and Services (Rechercher des API et services), saisissez Business Messages.
- Sélectionnez API Business Messages.
- Cliquez sur Activer.
- Cliquez sur Activer les API et les services.
- Dans le champ Rechercher des API et des services, saisissez Communications commerciales.
- Sélectionnez API Business Communications.
- Cliquez sur Activer.
Votre clé API dispose désormais des autorisations nécessaires pour accéder aux documents OpenAPI des API Business Messages et Business Communications.
Accéder aux documents OpenAPI
Exécutez cette commande pour accéder au document OpenAPI pour l'API Business Messages :
curl "https://businessmessages.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"
Exécutez cette commande pour accéder au document OpenAPI pour l'API Business Communications :
curl "https://businesscommunications.googleapis.com/$discovery/swagger2?version=v1&key=API_KEY"
Remplacez API_KEY par votre clé API.