API İstemcisi
Paragraph CMS için resmi TypeScript SDK. API anahtarlarıyla uygulamaları bağlayarak sayfalar, koleksiyonlar ve yerel ayarlar genelinde içerik getirin, listeleyin, oluşturun ve güncelleyin.
Grzegorz
API İstemcisi, Paragraph CMS için resmi TypeScript SDK'sıdır. İster bir web sitesi ön yüzü, ister sunucu taraflı bir entegrasyon, ister dahili bir otomasyon olsun, CMS'de depolanan içerikle çalışmak için harici uygulamalara düzenli bir yol sunar.
API Keys ile çalışacak şekilde tasarlanmıştır ve Paragraph CMS içindeki editoryal çalışma ile bu içeriği son kullanıcılara ulaştıran uygulamalar arasındaki ana köprüdür.
Ekipler bunu ne için kullanır
API İstemcisi, bir ön yüzün veya hizmetin şunları yapması gerektiğinde en kullanışlıdır:
slug, koleksiyon veya yerel ayara göre sayfaları getirmek,
blog ya da dokümantasyon alanı gibi bir bölüm için içerik listelemek,
koleksiyonları, etiketleri, durumları, veri modellerini, yerel ayarları veya medyayı okumak,
ya da içerikleri programatik olarak oluşturmak ve güncellemek.
Bu da onu Next.js, Astro, React Router, Nuxt ve SvelteKit ile oluşturulan projeler için doğal bir seçenek hâline getirir.
Bir API anahtarıyla bağlayın
Olağan kurulum basittir: Paragraph CMS içinde bir anahtar oluşturun, bunu uygulamanıza ekleyin ve istemcinin herkese açık API'ye yapılan istekleri yönetmesine izin verin.
Bu, editoryal yüzey ile sunum yüzeyini birbirinden ayrı tutar. Ekipler içeriği Pages, Collections ve Data Models içinde yönetebilir, ardından gerektiği yerde bu içeriği okumak veya güncellemek için uygulama kodlarında istemciyi kullanabilir.
Editoryal iş akışına yakın
Paragraph CMS ayrıca ürün içinde kod örnekleri de sunar; bu da içerik kurulumundan uygulamaya geçmeyi kolaylaştırır. Koleksiyonlar, sayfalar, etiketler ve durumların tümü, istemci tarafından desteklenen ön yüz veya otomasyon çalışmalarına doğrudan katkı sağlayabilir.
Bu, özellikle aynı ekip hem CMS yapısının hem de onu kullanan site ya da uygulamanın sahibi olduğunda çok kullanışlıdır.
Diğer sunum araçlarıyla iyi çalışır
API İstemcisi, aynı içerik kaynağından site düzeyinde site haritaları ve akışlar gibi SEO dosyaları oluşturan SEO Client için de temel katmandır.
