Önemli: JSON API 2.0 API'si için sunduğumuz destek 30 Eylül 2024'ten itibaren sonlandırılacaktır. İşlevlerin devam etmesi için JSON 2.0 API'sini kullanan uygulamalarınızı en son API sürümüne güncelleyin. En son sürüm için, sol taraftaki gezinme çubuğundaki bağlantıları kullanın.
Bu dokümanda, Blogger JSON API'sini kullanmaya nasıl başlayacağınız açıklanmaktadır.
İçindekiler
Giriş
Bu belge, Blogger JSON API ile etkileşim kurabilecek uygulamalar yazmak isteyen geliştiricilere yöneliktir.
Blogger JSON API, Blogger Veri API'sının 2.0 sürümünü genişletir. Blogger'daki verileri XML yerine JSON biçiminde almak istiyorsanız Blogger JSON API'yi kullanın. Verileri XML biçiminde almak istiyorsanız Blogger Veri API'sını kullanın.
Blogger JSON API'nin bu sürümü şu anda salt okunurdur; ancak okuma/yazma özelliklerinin yanı sıra başka özellikler eklemeyi planlıyoruz. Blogger Yardım Forumu'ndan diğer özellikleri talep etmekten çekinmeyin.
Başlamadan önce
Bir Google Hesabı edinin
Oluşturulmuş bir Google Hesabınız olduğundan emin olun. Kendinizi kazara veri kaybından korumak amacıyla geliştirme ve test amaçlı ayrı bir Google Hesabı kullanmanızı öneririz. Bir test hesabınız varsa, hazırsınız demektir. Test verilerinizi ayarlamak, düzenlemek veya görüntülemek için Blogger kullanıcı arayüzünü ziyaret edebilirsiniz.
Blogger'ı tanıyın
Blogger kavramlarına aşina değilseniz bu dokümanı okuyun ve kodlamaya başlamadan önce kullanıcı arayüzü ile denemeler yapın. Bu dokümanda Blogger, web programlama kavramları ve web veri biçimleri hakkında bilgi sahibi olduğunuz varsayılmaktadır.
İstekleri yetkilendirme ve uygulamanızı tanımlama hakkında bilgi edinin
Uygulamanız gizli veri isteğinde bulunduğunda isteğin, söz konusu verilere erişimi olan kimliği doğrulanmış bir kullanıcı tarafından yetkilendirilmesi gerekir.
Uygulamanız herkese açık veri isteğinde bulunduğunda isteğin yetkilendirilmesi gerekmez, ancak API anahtarı gibi bir tanımlayıcıya eşlik etmesi gerekir.
İstekleri yetkilendirme ve API anahtarlarını kullanma hakkında bilgi edinmek için API'yi kullanma belgesindeki İstekleri yetkilendirme ve uygulamanızı tanımlama bölümüne bakın.
Blogger JSON API arka planı
Blogger kavramları
Blogger beş temel kavram üzerine kurulmuştur:
- Bloglar: API'nin temel konseptidir. Bir blogda yayınlar ve sayfalar bulunur. Bu, Blog Adı ve Açıklama gibi blog meta bilgilerinin kapsayıcısıdır.
- Yayınlar: Blog yayını, blog yazarının oluşturduğu yayınlanabilir öğedir. Bu bilgilerin zamanında gönderilmesi ve yazarların şu anda dünyada yayınlamak istediklerini yansıtması amaçlanmaktadır. Zaman geçtikçe blog yayınları içeriğinin yaşlandığı ve daha az alakalı hale geldiği bilinmektedir.
- Yorumlar: Yorum, blog yayınının yazarı dışındaki kişilerin yazarın yazdıklarına tepki verdiği yerdir. Tuğladan bukete kadar her şey.
- Sayfalar: Sayfa, biyografik bilgiler veya kullanıcıyla iletişim kurma yöntemleri gibi statik içeriklerin yer aldığı bir yerdir. Bunlar genellikle çok sık değişmeyen zamana bağlı olmayan bilgilerdir.
- Kullanıcılar: Kullanıcı, Yazar, Yönetici veya yalnızca Okuyucu olarak hareket ederek Blogger ile etkileşimde bulunan kişidir. Herkese açık bloglarda okuyucular anonim olabilir, ancak özel bloglarda okuyucu Blogger tarafından tanımlanır.
Blogger JSON API veri modeli
Kaynak, benzersiz bir tanımlayıcısı olan bağımsız bir veri varlığıdır. Blogger JSON API beş tür kaynakta çalışır:
- Bloglar Kaynağı: Bir blogu temsil eder.
- Yayın Kaynağı: Bir yayını temsil eder. Her Yayın Kaynağı, Bloglar Kaynağının alt öğesidir.
- Yorum Kaynağı: Belirli bir yayındaki yorumu temsil eder. Her Yorum Kaynağı, bir Yayın Kaynağının alt öğesidir.
- Sayfa Kaynağı: Statik bir sayfayı temsil eder. Her Sayfa Kaynağı, Bloglar Kaynağının bir alt öğesidir.
- Kullanıcılar Kaynağı: Anonim olmayan bir kullanıcıyı temsil eder. Bu ad; bir Sayfanın, yayının veya yorumun yazarını tanımlamak için kullanılır.
Blogger JSON API veri modeli, koleksiyon adı verilen kaynak gruplarına dayanır:
- Blog Koleksiyonu
- <span="apicollection">Blog Koleksiyonu, bir kullanıcının erişim hakkına sahip olduğu tüm Blog'lardan oluşur. Blogları kullanıcıya göre listeleyebilir veya kimliğe göre tek bir Blog alabilirsiniz.</span="apicollection">
- Yayın Koleksiyonu
- Yayın Koleksiyonu, belirli bir Blog Kaynağı içindeki tüm Yayın Kaynaklarından oluşur.
- Yorum Toplama
- Yorum Koleksiyonu belirli bir Yayın Kaynağı içindeki tüm Yorum Kaynakları'ndan oluşur.
- Sayfa Koleksiyonu
- Sayfa Koleksiyonu, belirli bir Blog Kaynağı içindeki tüm Sayfa Kaynakları'ndan oluşur.
- Kullanıcı Koleksiyonu
- Kullanıcı Koleksiyonu, Blogger'daki tüm Kullanıcı Kaynakları'nı içerdiğinden listelenemez. Bir kullanıcı, kimliğe göre veya
selftanımlayıcısını kullanarak kendi Kullanıcı Kaynağını alabilir (ancak başka kimsenin kaynağı olamaz).
Blogger JSON API işlemleri
Aşağıdaki tabloda açıklandığı gibi Blogger JSON API'deki koleksiyonlar ve kaynaklar üzerinde iki farklı yöntemi çağırabilirsiniz.
| İşlem | Açıklama | REST HTTP eşlemeleri |
|---|---|---|
| list | Bir koleksiyondaki tüm kaynakları listeler. | Koleksiyon URI'sında GET. |
| al | Belirli bir kaynağı alır. | Kaynak URI'sında GET. |
Aşağıdaki tabloda, her kaynak türü tarafından desteklenen yöntemler gösterilmektedir. Özel bloglardaki tüm list ve get işlemleri için kimlik doğrulama gerekir.
Kaynak Türü |
Desteklenen Yöntemler |
|
|---|---|---|
| listesi | get | |
| Bloglar | evet | evet |
| Yayınlar | evet | evet |
| Yorumlar | evet | evet |
| Sayfalar | evet | evet |
| Kullanıcı sayısı | no | evet |
Arama stilleri
API'yi çağırmanın birkaç yolu vardır:
- Doğrudan REST'i veya JavaScript'i kullanarak (sunucu tarafı kod gerekmez)
- İstemci kitaplıklarını kullanma.
REST
REST, veri isteme ve değiştirmeye kullanışlı ve tutarlı yaklaşım sağlayan bir yazılım mimarisi stilidir.
REST terimi, "Representational State Transfer"in (Temsili Durum Aktarımı) kısaltmasıdır. Google API'leri bağlamında, Google tarafından saklanan verilerin temsillerini almak ve değiştirmek için HTTP fiillerini kullanma anlamına gelir.
RESTful bir sistemde, kaynaklar bir veri deposunda saklanır. Bir istemci, sunucunun belirli bir işlemi (ör. kaynak oluşturma, alma, güncelleme veya silme) gerçekleştirmesi için istek gönderir. Sunucu, işlemi gerçekleştirir ve yanıt gönderir. Bu yanıt genelde belirtilen kaynağın bir temsili biçimindedir.
Google'ın RESTful API'lerinde istemci, POST, GET, PUT veya DELETE gibi bir HTTP fiili kullanarak işlem belirtir. Aşağıdaki biçimde bulunan genel olarak benzersiz bir URI ile bir kaynağı belirtir:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Tüm API kaynaklarının HTTP tarafından erişilebilen benzersiz URI'ları olduğu için REST, veri önbelleğe almayı etkinleştirir ve web'deki dağıtılan altyapıyla birlikte çalışmak üzere optimize edilmiştir.
HTTP 1.1 standartları belgelerindeki yöntem tanımlarını yararlı bulabilirsiniz. Bu tanımlar, GET, POST, PUT ve DELETE özelliklerini içerir.
Blogger JSON API'de REST
Desteklenen Blogger işlemleri, Blogger JSON API işlemlerinde açıklandığı gibi doğrudan REST HTTP fiilleriyle eşlenir.
Blogger JSON API URI'ları için özel biçim şu şekildedir:
https://www.googleapis.com/blogger/v2/users/userId https://www.googleapis.com/blogger/v2/users/self https://www.googleapis.com/blogger/v2/users/userId/blogs https://www.googleapis.com/blogger/v2/users/self/blogs https://www.googleapis.com/blogger/v2/blogs/blogId/posts https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId https://www.googleapis.com/blogger/v2/blogs/blogId/pages https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId
Kullanılan URI'ların tam açıklaması ve API'de desteklenen her işlemin sonuçları Blogger JSON API Referansı belgesinde özetlenmiştir.
Bunun Blogger JSON API'sinde nasıl çalıştığına dair birkaç örneği burada bulabilirsiniz.
Kimliği doğrulanmış kullanıcının erişim haklarına sahip olduğu blogları listeleyin:
GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY
code.blogger.com blogundaki (blog kimliği 3213900 olan) yayınları alın:
GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY
JavaScript'ten REST
Blogger JSON API'yi, callback sorgu parametresi ve bir geri çağırma işlevi ile JavaScript'te REST kullanarak çağırabilirsiniz. Bu, herhangi bir sunucu tarafı kodu yazmadan Blogger verilerini görüntüleyen zengin uygulamalar yazmanıza olanak tanır.
Aşağıdaki örnek, code.blogger.com blogundan (YOUR-API-KEY değerini API anahtarınızla değiştirmenizden sonra) bir yayın alır.
<html>
<head>
<title>Blogger JSON API Example</title>
</head>
<body>
<div id="content"></div>
<script>
function handleResponse(response) {
document.getElementById("content").innerHTML += "<h1>" + response.title + "</h1>" + response.content;
}
</script>
<script
src="https://www.googleapis.com/blogger/v2/blogs/3213900/posts/8398240586497962757?callback=handleResponse&key=YOUR-API-KEY"></script>
</body>
</html>
Veri biçimi
JSON
JSON (JavaScript Object Notation [JavaScript Object Notasyonu]), rastgele veri yapılarının basit metin temsilini sağlayan yaygın, dilden bağımsız bir veri biçimidir. Daha fazla bilgi için json.org adresine bakın.