OpenAPI

OpenAPI adalah spesifikasi untuk menjelaskan REST API. Menggunakan Spesifikasi OpenAPI 2.0, Anda dapat membuat dokumen OpenAPI untuk Business Messages dan Business API Komunikasi untuk mendeskripsikan strukturnya.

Dengan begitu, Anda dapat melakukan tindakan 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 tersebut mendefinisikan nama dan deskripsi API, masing-masing endpoint (jalur) dalam API, cara pemanggil diautentikasi, dan banyak lagi.

Klik di bawah ini 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 lebih lanjut tentang struktur dokumen OpenAPI, lihat Situs suvenir.

Cara mengakses dokumen OpenAPI

Untuk mengakses dokumen OpenAPI, Anda harus memiliki kunci API dari akun Project platform (GCP) dengan Business Messages dan Business Communications API diaktifkan.

Ikuti bagian di bawah ini 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 hal berikut:

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

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

6. Klik Buat.

Membuat kunci API

1. Buka Halaman Credentials di konsol GCP.

2. Klik Create credentials, lalu pilih API key.

   Kotak dialog API key created akan menampilkan kunci yang baru dibuat. Salin kunci Anda dan simpan dengan aman. 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 API & Layanan di konsol GCP.
2. Di menu drop-down Select project, pilih project yang APInya ingin Anda aktifkan.
3. Klik Aktifkan API dan Layanan.
4. Di kolom Search for APIs and Services, masukkan Business Messages.
5. Pilih Business Messages API.
6. Klik Aktifkan.
7. Klik Aktifkan API dan Layanan.
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.