OpenAPI.

OpenAPI to specyfikacja opisująca interfejsy API REST. Za pomocą specyfikacji OpenAPI 2.0 możesz tworzyć dokumenty OpenAPI dla interfejsów Business Messages i Business Communication API, które opisują ich strukturę.

Dzięki temu możesz:

  • Utwórz biblioteki klienta w preferowanym języku
  • Utwórz wycinki serwerów
  • Używanie narzędzi do zarządzania interfejsami API

Podstawowa struktura dokumentu OpenAPI

Dokument OpenAPI opisuje powierzchnię interfejsu API typu REST. Dokument zawiera nazwę i opis interfejsu API, poszczególne punkty końcowe (ścieżki) w interfejsie API, sposób uwierzytelniania wywołujących i inne informacje.

Kliknij poniżej, aby zobaczyć przykład tej podstawowej struktury.

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"
              }
            }
          }
        }
      }
    }

Aby dowiedzieć się więcej o strukturze dokumentu OpenAPI, odwiedź stronę Swagger.

Jak uzyskać dostęp do dokumentów OpenAPI

Aby uzyskać dostęp do dokumentów OpenAPI, musisz mieć klucz interfejsu API z projektu Google Cloud Platform (GCP) z włączonymi interfejsami Business Messages i Business Communications API.

Wykonaj czynności poniżej, aby

  • utwórz projekt GCP
  • utworzenie klucza API
  • włączyć Business Messages API i Business Communications API;

Po wykonaniu tych czynności możesz uzyskać dostęp do dokumentów OpenAPI.

Tworzenie projektu GCP

Jeśli masz już projekt GCP, możesz go użyć, aby utworzyć klucz interfejsu API.

Aby utworzyć nowy projekt GCP, wykonaj te czynności:

  1. Otwórz stronę Zarządzanie zasobami w konsoli GCP.
  2. Na liście Wybierz organizację u góry strony wybierz organizację, dla której chcesz utworzyć projekt. Jeśli korzystasz z bezpłatnego okresu próbnego, pomiń ten krok.
  3. Kliknij Utwórz projekt.
  4. W oknie Nowy projekt wpisz nazwę projektu i wybierz odpowiednie konto rozliczeniowe. Nazwa projektu może zawierać tylko litery, cyfry, pojedyncze cudzysłowy, łączniki, spacje oraz wykrzykniki i musi mieć od 4 do 30 znaków.

  5. W polu Location (Lokalizacja) wpisz organizację nadrzędną lub folder nowego projektu.

  6. Kliknij Utwórz.

utworzysz klucz interfejsu API;

  1. Otwórz stronę Dane logowania w konsoli GCP.

  2. Kliknij Utwórz dane logowania i wybierz Klucz interfejsu API.

    W oknie Utworzono klucz API wyświetli się nowo utworzony klucz. Skopiuj klucz i zachowaj go. Więcej informacji o kluczach interfejsu API znajdziesz w dokumentacji kluczy interfejsu API.

Włącz Business Communications API i Business Messages API

Aby włączyć te interfejsy API w projekcie GCP:

  1. Otwórz stronę Interfejsy API i usługi w konsoli GCP.
  2. Na liście Wybierz projekt zaznacz projekt, dla którego chcesz włączyć interfejsy API.
  3. Kliknij Włącz interfejsy API i usługi.
  4. W polu Wyszukaj interfejsy API i usługi wpisz Business Messages (Wiadomości biznesowe).
  5. Wybierz Business Messages API.
  6. Kliknij Enable (Włącz).
  7. Kliknij Włącz interfejsy API i usługi.
  8. W polu Wyszukaj interfejsy API i usługi wpisz Business Communications.
  9. Wybierz Business Communications API.
  10. Kliknij Enable (Włącz).

Twój klucz API ma teraz uprawnienia dostępu do dokumentów OpenAPI dokumentów Business Messages i Business Communications API.

Dostęp do dokumentów OpenAPI

Aby uzyskać dostęp do dokumentu OpenAPI dokumentu Business Messages API, uruchom to polecenie:

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

Aby uzyskać dostęp do dokumentu OpenAPI dokumentu Business Communications API, uruchom to polecenie:

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

Zastąp API_KEY kluczem interfejsu API.