OpenAPI

OpenAPI, bir REST API'lerini tanımlamaya yönelik teknik özelliklerdir. Kullanım OpenAPI spesifikasyonu 2.0, Business Messages ve Business için OpenAPI dokümanları oluşturabilirsiniz Communications API'leri (iletişim API'leri) kullanmaya başladı.

Bu sayede aşağıdakileri yapabilirsiniz:

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

OpenAPI belgesinin temel yapısı

OpenAPI belgesinde REST API'nin temelleri açıklanmaktadır. Bu belgede API'nin adını ve açıklamasını, API, çağrı yapanların kimliğinin nasıl doğrulandığı ve daha fazlası.

Bu temel yapının bir örneğini görmek için aşağıdaki bağlantı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 belgesinin yapısı hakkında daha fazla bilgi edinmek için Swagger web sitesi.

OpenAPI belgelerine erişme

OpenAPI belgelerine erişmek için Google Cloud'dan API anahtarınız olmalıdır Business Messages ve Business Communications'ı içeren Platform (GCP) projesi API'ler etkinleştirildi.

Aşağıdaki bölümleri takip ederek

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

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

GCP projesi oluşturma

Zaten bir GCP projeniz varsa API anahtarı oluşturmak için bu projeyi kullanabilirsiniz.

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

1. Kaynakları yönetin'e gidin. sayfasında yer alır.
2. Sayfanın üst kısmındaki Kuruluş seçin açılır listesinde, proje 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 bir faturalandırma hesabınıza gidin. Bir proje adı yalnızca harf, rakam, Tırnak işareti, kısa çizgi, boşluk veya ünlem işareti olmalı ve 4 ile 30 karakter arasında olmalıdır.

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

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

API anahtarı oluşturma

1. Şuraya gidin: Kimlik bilgileri sayfası .

2. Create credentials'ı (Kimlik bilgileri oluştur) tıklayın ve ardından API key'i (API anahtarı) seçin.

   API anahtarı oluşturuldu iletişim kutusunda yeni oluşturulan anahtarınız gösterilir. Anahtarınızı kopyalayın ve güvende tutun. API anahtarları hakkında daha fazla bilgi edinmek için API anahtarı dokümanları.

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

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

1. API'ler ve Hizmetler sayfasından ulaşabilirsiniz.
2. Proje seçin açılır listesinden onay kutusunu işaretleyin.
3. API'leri ve Hizmetleri Etkinleştir'i tıklayın.
4. API ve Hizmet Arayın alanına Business Messages 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 Business Communication yazın.
9. Business Communications API'yi seçin.
10. Etkinleştir'i tıklayın.

Artık API anahtarınızın Business Messages ve Business Communications API'leri.

OpenAPI dokümanlarına erişme

Business Messages API ile ilgili 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 ile ilgili OpenAPI dokümanına erişmek için ş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.