API Terbuka

OpenAPI adalah spesifikasi untuk mendeskripsikan REST API. Dengan spesifikasi OpenAPI 2.0, Anda dapat membuat dokumen OpenAPI untuk Business Messages dan Business Communications API untuk mendeskripsikan strukturnya.

Hal ini memungkinkan Anda melakukan hal berikut:

  • Membuat library klien dalam bahasa pilihan Anda
  • Membuat stub server
  • Menggunakan alat pengelolaan API

Struktur dasar dokumen OpenAPI

Dokumen OpenAPI menjelaskan platform REST API. Dokumen ini menetapkan nama dan deskripsi API, masing-masing endpoint (jalur) di API, cara pemanggil diautentikasi, dan lainnya.

Klik di bawah untuk melihat contoh struktur dasar ini.

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

Untuk mempelajari struktur dokumen OpenAPI lebih lanjut, lihat situs Swagger.

Cara mengakses dokumen OpenAPI

Untuk mengakses dokumen OpenAPI, Anda harus memiliki kunci API dari project Google Cloud Platform (GCP) dengan Business Messages dan Business Communications API yang diaktifkan.

Ikuti bagian di bawah untuk

  • membuat project GCP
  • membuat kunci API
  • mengaktifkan Business Messages API dan Business Communications API

Setelah menyelesaikan langkah-langkah ini, Anda dapat mengakses dokumen OpenAPI.

Membuat project GCP

Jika sudah memiliki project GCP, Anda dapat menggunakannya untuk membuat kunci API.

Untuk membuat project GCP baru, lakukan langkah berikut:

  1. Buka halaman Mengelola resource di GCP console.
  2. Di menu drop-down Select organization di bagian atas halaman, pilih organisasi yang ingin Anda buatkan project. Jika Anda adalah pengguna uji coba gratis, lewati langkah ini.
  3. Klik Buat Project.
  4. Di jendela New Project, masukkan nama project dan pilih akun penagihan yang berlaku. Nama project hanya boleh berisi huruf, angka, tanda petik tunggal, tanda hubung, spasi, atau tanda seru, dan harus terdiri dari 4 hingga 30 karakter.

  5. Untuk Location, masukkan organisasi induk atau folder untuk project baru.

  6. Klik Buat.

Membuat kunci API

  1. Buka halaman Credentials di GCP Console.

  2. Klik Create credentials, lalu pilih API key.

    Kotak dialog API key created akan menampilkan kunci yang baru dibuat. Salin kunci Anda dan jaga keamanannya. Untuk mempelajari kunci API lebih lanjut, lihat dokumentasi kunci API.

Mengaktifkan Business Communications API dan Business Messages API

Untuk mengaktifkan API ini di project GCP Anda, lakukan hal berikut:

  1. Buka halaman APIs & amp; Services di GCP console.
  2. Di menu drop-down Select project, pilih project yang ingin Anda aktifkan API-nya.
  3. Klik Enable APIs and Services.
  4. Di kolom Search for APIs and Services, masukkan Business Messages.
  5. Pilih Business Messages API.
  6. Klik Aktifkan.
  7. Klik Enable APIs and Services.
  8. Di kolom Search for APIs and Services, masukkan Business Communications.
  9. Pilih Business Communications API.
  10. Klik Aktifkan.

Sekarang kunci API Anda memiliki izin untuk mengakses dokumen OpenAPI untuk Business Messages dan Business Communications API.

Mengakses dokumen OpenAPI

Jalankan perintah ini untuk mengakses dokumen OpenAPI untuk Business Messages API: 

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

Jalankan perintah ini untuk mengakses dokumen OpenAPI untuk Business Communications API: 

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

Ganti API_KEY dengan kunci API Anda.