Ana içeriğe atla
CMS API, Plato CMS’de oluşturduğunuz özel veritabanlarını ortaya çıkarır. Plato çalışma alanından yapılandırılmış içeriğe ihtiyaç duyan web siteleri, kataloglar, açılış sayfaları, iş ortağı portalları ve dahili araçlar için bunu kullanın.

Girişleri Listele

Alanlar, filtreler, sayfalandırma ve tahmin edilebilir yanıt başlıkları içeren girişleri getirin.

Bir Giriş Alın

Güvenilir bir entegrasyondan tek bir CMS girişini kimliğe göre okuyun.

Giriş Oluştur

Bir arka uçtan, web sitesinden veya dahili araçtan yeni CMS içeriği ekleyin.

Girişi Güncelle

Mevcut CMS içeriğini güvenli bir şekilde yamalayın veya değiştirin.

Girişi Sil

Entegrasyon yaşam döngüsünün sahibi olduğunda CMS kayıtlarını kaldırın.

Alanlar ve İlişkiler

Değerleri, sistem alanlarını, ilişki kimliklerini ve bağlantılı içeriği anlayın.

Uç noktalar

GET    /api/public/cms/[modelId]/list
POST   /api/public/cms/[modelId]/list
GET    /api/public/cms/[modelId]/[id]
PATCH  /api/public/cms/[modelId]/[id]
PUT    /api/public/cms/[modelId]/[id]
DELETE /api/public/cms/[modelId]/[id]
modelId, CMS veritabanı tanımlayıcısı veya veritabanı kimliği olabilir. Mümkün olduğunda products, locations veya team_members gibi okunabilir veritabanı tanımlayıcılarını kullanın. API URL’lerinin bakımını kolaylaştırırlar.

Kimlik doğrulama

CMS uç noktaları şunları kabul eder:
Authorization: Bearer plato_your_api_key
veya:
x-api-key: plato_your_api_key
Daha eski entegrasyonlar şunları kullanabilir:
?apiKey=plato_your_api_key
API anahtar rolü CMS erişimini içermelidir.

Sistem Alanları

Her giriş şunları içerebilir:
AlanAnlam
idGiriş kimliği.
createdAtGiriş oluşturma tarihi.
updatedAtMevcut olduğunda son güncelleme tarihi.
Bu alanlar, hiçbir fields sorgusu gönderilmediğinde varsayılan olarak seçilir.

Yanıt Başlıkları

Liste ve giriş yanıtları CMS meta veri başlıklarını içerir.
BaşlıkAnlam
x-cms-model-idİstekle eşleşen dahili veritabanı kimliği.
x-cms-model-identifierYapılandırıldığında okunabilir veritabanı tanımlayıcısı.
x-cms-totalListe istekleri için toplam giriş sayısı.
x-cms-limitListe isteği tarafından kullanılan sınır.
x-cms-offsetListe isteği tarafından kullanılan uzaklık.
x-cms-has-moreDaha fazla satır mevcut olduğunda 1.

Tipik Akış

  1. Plato’de CMS veritabanını oluşturun veya açın.
  2. Veritabanı tanımlayıcısını ve alan anahtarlarını onaylayın.
  3. CMS erişimine sahip bir API anahtarı oluşturun.
  4. Girişleri uygulamanızın ihtiyaç duyduğu alanlarla listeleyin.
  5. Yalnızca güvenilen sunucu kodundan oluşturma, güncelleme ve silme işlemlerini kullanın.
Şema kurulumu için bkz. CMS Geliştirici Araçları.