API İstemcisi
Paragraph CMS için resmi TypeScript SDK. Sayfalar, koleksiyonlar ve yerel ayarlar genelinde içerik getirmek, listelemek, oluşturmak ve güncellemek için uygulamaları API anahtarlarıyla bağlayın.
Grzegorz
API İstemcisi, Paragraph CMS için resmi TypeScript SDK'sıdır. Harici uygulamalara, bunun bir web sitesi ön ucu, sunucu tarafı entegrasyonu veya dahili bir otomasyon olması fark etmeksizin, CMS'de depolanan içerikle çalışmak için temiz 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 en çok, bir ön uç veya hizmetin şunları yapması gerektiğinde faydalıdır:
slug, koleksiyon veya yerel ayara göre sayfaları getirmek,
blog veya dokümantasyon alanı gibi bir bölüm için içeriği listelemek,
koleksiyonları, etiketleri, durumları, veri modellerini, yerel ayarları veya medyayı okumak,
ya da programatik olarak içerik 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 uyum haline getirir.
Bir API anahtarıyla bağlayın
Genel kurulum basittir: Paragraph CMS'te bir anahtar oluşturun, bunu uygulamanıza ekleyin ve istemcinin genel API'ye yapılan istekleri yönetmesine izin verin.
Bu, editoryal yüzey ile sunum yüzeyini 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 uç veya otomasyon çalışmalarını doğrudan besleyebilir.
Bu, özellikle aynı ekip hem CMS yapısının hem de onu tüketen site ya da uygulamanın sahibi olduğunda faydalı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.
Kategoriler ve AI meta verileri desteği
Genel v1 API ayrıca koleksiyonlar için kategori işlemlerini ve sayfa, hero ve görsel meta verileri üreten AI yardımcılarını da içerir. Bu, entegrasyonlara uygulama dışında da aynı yapılandırılmış içerik ve meta veri iş akışlarını kullanılabilir tutmanın bir yolunu sunar.
