OpenAPI

OpenAPI è una per la descrizione delle API REST. Utilizzo Specifica OpenAPI 2.0, puoi creare documenti OpenAPI per Business Messages e Business API di comunicazione per descriverne la struttura.

Ciò ti consente di:

• Crea librerie client nel tuo linguaggio preferito
• Creazione stub del server
• Utilizza gli strumenti di gestione delle API

Struttura di base di un documento OpenAPI

Un documento OpenAPI descrive la superficie di un'API REST. Il documento definisce il nome e la descrizione dell'API, i singoli endpoint (percorsi) nella API, modalità di autenticazione dei chiamanti e altro ancora.

Fai clic di seguito per visualizzare un esempio di questa struttura di 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"
              }
            }
          }
        }
      }
    }
    

Per saperne di più sulla struttura di un documento OpenAPI, consulta Sito web di spalti.

Come accedere ai documenti OpenAPI

Per accedere ai documenti OpenAPI, devi disporre di una chiave API di un account Google Cloud Progetto Platform (Google Cloud) con Business Messages e Business Communications API abilitate.

Segui le sezioni riportate di seguito per

• crea un progetto Google Cloud
• crea una chiave API
• abilita l'API Business Messages e l'API Business Communications

Una volta completati questi passaggi, potrai accedere ai documenti OpenAPI.

Crea un progetto della piattaforma Google Cloud

Se hai già un progetto Google Cloud, puoi utilizzarlo per creare una chiave API.

Per creare un nuovo progetto Google Cloud, segui questi passaggi:

1. Vai alla pagina Gestisci risorse. nella console Google Cloud.
2. Nell'elenco a discesa Seleziona organizzazione nella parte superiore della pagina, seleziona l'organizzazione per la quale vuoi creare il progetto. Se sei un utente in prova senza costi, salta questo passaggio.
3. Fai clic su Crea progetto.
4. Nella finestra Nuovo progetto, inserisci un nome per il progetto e seleziona un l'account di fatturazione, a seconda dei casi. Un nome di progetto può contenere solo lettere, numeri, numeri tra virgolette, trattini, spazi o punti esclamativi e deve avere una lunghezza compresa tra 4 e 30 caratteri.

5. In Posizione, inserisci l'organizzazione o la cartella padre per il nuovo progetto.

6. Fai clic su Crea.

crea una chiave API

1. Vai alla sezione Pagina delle credenziali nella console Google Cloud.

2. Fai clic su Crea credenziali, quindi seleziona Chiave API.

   Nella finestra di dialogo Chiave API creata viene visualizzata la chiave appena creata. Copia la chiave e tienila al sicuro. Per ulteriori informazioni sulle chiavi API, consulta documentazione sulla chiave API.

Attivare l'API Business Communications e l'API Business Messages

Per abilitare queste API nel tuo progetto Google Cloud, segui questi passaggi:

1. Vai alla pagina API e Services nella console di Google Cloud.
2. Nell'elenco a discesa Seleziona progetto, seleziona la per il quale vuoi abilitare le API.
3. Fai clic su Abilita API e servizi.
4. Nel campo Cerca API e servizi, inserisci Business Messages.
5. Seleziona API Business Messages.
6. Fai clic su Abilita.
7. Fai clic su Abilita API e servizi.
8. Nel campo Cerca API e servizi, inserisci Business Communications.
9. Seleziona API Business Communications.
10. Fai clic su Abilita.

Ora la chiave API dispone delle autorizzazioni per accedere ai documenti OpenAPI per API Business Messages e Business Communications.

Accesso ai documenti OpenAPI

Esegui questo comando per accedere al documento OpenAPI per l'API Business Messages:

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

Esegui questo comando per accedere al documento OpenAPI per l'API Business Communications:

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

Sostituisci API_KEY con la tua chiave API.