OpenAPI

OpenAPI, REST API'leri açıklamak için kullanılan bir spesifikasyondur. Business Messages ve Business Communication API'lerin yapılarını açıklamak amacıyla OpenAPI spesifikasyonu 2.0'ı kullanarak OpenAPI dokümanları oluşturabilirsiniz.

Bu sayede aşağıdakileri yapabilirsiniz:

  • Tercih ettiğiniz dilde istemci kitaplıkları oluşturun
  • Sunucu saplaması oluşturma
  • API yönetimi araçlarını kullanma

OpenAPI belgesinin temel yapısı

OpenAPI dokümanı, bir REST API'sinin yüzeyini açıklar. Belgede API'nin adı ve açıklaması, API'deki bağımsız uç noktalar (yollar), arayanların kimliğinin nasıl doğrulandığı ve daha fazlası tanımlanır.

Bu temel yapıya ilişkin bir örneği görmek için aşağıyı tıklayın.

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

OpenAPI dokümanının yapısı hakkında daha fazla bilgi edinmek için Swagger web sitesine bakın.

OpenAPI dokümanlarına erişme

OpenAPI dokümanlarına erişmek için Business Messages ve Business Communications API'lerin etkinleştirildiği bir Google Cloud Platform (GCP) projesinden API anahtarınız olması gerekir.

Aşağıdaki bölümleri izleyerek

  • GCP projesi oluşturma
  • API anahtarı oluşturma
  • Business Messages API ve Business Communications API'yi etkinleştirme

Bu adımlar tamamlandıktan sonra OpenAPI dokümanlarına erişebilirsiniz.

GCP projesi oluşturma

Halihazırda bir GCP projeniz varsa API anahtarı oluşturmak için bunu kullanabilirsiniz.

Yeni bir GCP projesi oluşturmak için aşağıdakileri yapın:

  1. GCP konsolundaki Kaynakları yönet sayfasına gidin.
  2. Sayfanın üst kısmındaki Kuruluş seçin açılır listesinden projesini oluşturmak istediğiniz kuruluşu seçin. Ücretsiz deneme kullanıcısıysanız bu adımı atlayın.
  3. Proje Oluştur'u tıklayın.
  4. Yeni Proje penceresinde bir proje adı girin ve uygun şekilde bir faturalandırma hesabı seçin. Proje adı yalnızca harf, rakam, tek tırnak işareti, kısa çizgi, boşluk veya ünlem işareti içerebilir ve 4 ila 30 karakter uzunluğunda olmalıdır.

  5. Konum alanına, yeni projenin üst kuruluşunu veya klasörünü girin.

  6. Oluştur'u tıklayın.

API anahtarı oluşturma

  1. GCP konsolunda Kimlik bilgileri sayfasına gidin.

  2. Kimlik bilgisi oluştur'u tıklayın ve API anahtarı'nı seçin.

    API anahtarı oluşturuldu iletişim kutusunda yeni oluşturulan anahtar gösterilir. Anahtarınızı kopyalayıp güvenli bir şekilde saklayın. API anahtarları hakkında daha fazla bilgi edinmek için API anahtarı dokümanlarını inceleyin.

Business Communications API ve Business Messages API'yi etkinleştirme

GCP projenizde bu API'leri etkinleştirmek için aşağıdakileri yapın:

  1. GCP Console'da API'ler ve Hizmetler sayfasına gidin.
  2. Proje seçin açılır listesinde API'leri etkinleştirmek istediğiniz projeyi seçin.
  3. API'leri ve Hizmetleri Etkinleştir'i tıklayın.
  4. API ve Hizmet Arayın alanına İşletmelerden Mesajlar yazın.
  5. Business Messages API'yi seçin.
  6. Etkinleştir'i tıklayın.
  7. API'leri ve Hizmetleri Etkinleştir'i tıklayın.
  8. API ve Hizmet Arayın alanına İş İletişimi yazın.
  9. Business Communications API'yi seçin.
  10. Etkinleştir'i tıklayın.

Artık API anahtarınız, Business Messages ve Business Communications API'leri için OpenAPI dokümanlarına erişim izinlerine sahip.

OpenAPI dokümanlarına erişme

Business Messages API'nin OpenAPI dokümanına erişmek için şu komutu çalıştırın: 

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

Business Communications API için OpenAPI dokümanına erişmek üzere şu komutu çalıştırın: 

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

API_KEY kısmını API anahtarınızla değiştirin.