API Modülü

Bu modül, bir uygulamayla API aracılığıyla iletişim kurmanızı sağlar. Uygulamanızda API yöntemleriyle birlikte API modülünü uyguladıktan sonra, gerekli uygulama verilerini yönetmek (yani değiştirmek veya silmek) için Crowdin API aracılığıyla uygulamanın API yöntemlerine erişebileceksiniz.

Bu modüle aşağıdaki kullanıcı kategorilerinden biri için erişim verebilirsiniz:

Crowdin için:

  • Sadece ben (yani proje sahibi)
  • Tüm proje üyeleri
  • Seçilen kullanıcılar

Crowdin Enterprise için:

  • Sadece kuruluş üst yöneticileri
  • Kuruluş projelerindeki tüm kullanıcılar
  • Seçilen kullanıcılar

Yapı

{
  "api": [
    {
      "key": "api-modül-anahtarınız",
      "name": "API yöntemi adı",
      "url": "/yol",
      "method": "GET",
      "description": "API yönteminin açıklaması",
      "documentationUrl": "/belgelere/giden/yol"
    }
  ]
}

Özellikler

key

Tür: dizgi

Zorunlu: evet

Açıklama: Crowdin uygulaması içindeki modül tanımlayıcısı.

name

Tür: dizgi

Zorunlu: evet

Açıklama: API yöntemi adı.

url

Tür: dizgi

Zorunlu: evet

Açıklama: API yöntemi için göreceli URL.

method

Tür: dizgi

İzin verilen değerler: GET, POST, PUT, PATCH, DELETE

Zorunlu: evet

Açıklama: API yöntemi türü.

description

Tür: dizgi

Açıklama: API yönteminin açıklaması.

documentationUrl

Tür: dizgi

Açıklama: API yöntemi belgeleri için göreceli URL.

Bu makale yararlı oldu mu?