Blogger JSON API'si: Başlarken

Bu dokümanda, Blogger JSON API'yi kullanmaya nasıl başlayabileceğiniz açıklanmaktadır.

İçindekiler

  1. Giriş
  2. Başlamadan önce
    1. Google Hesabı oluşturma
    2. Blogger hakkında bilgi edinin
    3. İstekleri yetkilendirme ve uygulamanızı tanımlama hakkında bilgi edinin
  3. Blogger JSON API arka planı
    1. Blogger kavramları
    2. Blogger JSON API veri modeli
    3. Blogger JSON API işlemleri
  4. Arama stili
    1. İSTE
  5. Veri biçimi
    1. JSON

Giriş

Bu doküman, Blogger JSON API ile etkileşimde bulunabilecek uygulamalar yazmak isteyen geliştiriciler için hazırlanmıştır.

Blogger JSON API, Blogger Veri API'sinin 2.0 sürümünü genişletir. Blogger'dan XML yerine JSON biçiminde veri almak istiyorsanız Blogger JSON API'yi kullanın. Verileri XML biçiminde almak isterseniz Blogger Data API'yi kullanın.

Blogger JSON API'nin bu sürümü şu anda salt okunur özelliktedir. Ancak okuma/yazma özelliklerinin yanı sıra diğer özellikleri de eklemeyi planlıyoruz. Blogger Yardım Forumu'ndan diğer özellikleri isteyebilirsiniz.

Başlamadan önce

Bir Google Hesabı edinin

Bir Google Hesabı oluşturduğunuzdan emin olun. Kendinizi kazara veri kaybından korumak için geliştirme ve test amacıyla ayrı bir Google Hesabı kullanmanızı öneririz. Mevcut bir test hesabınız varsa test verilerinizi oluşturmak, düzenlemek veya görüntülemek için Blogger kullanıcı arayüzünü ziyaret edebilirsiniz.

Blogger hakkında bilgi edinin

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 başvurunuzu 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 veriler istediğinde isteğin yetkilendirilmesi gerekmez, ancak API anahtarı gibi bir tanımlayıcıyla birlikte verilmesi gerekir.

İstekleri yetkilendirme ve API anahtarlarını kullanma hakkında bilgi edinmek için API kullanma dokümanındaki İ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 kavramı. Bir blogda gönderiler ve sayfalar bulunur. Bu, Blog Adı ve Açıklama gibi blog meta bilgilerinin kapsayıcısıdır.
  • Gönderiler: Blog yayını, blog yazarının oluşturduğu paylaşılabilir bir öğedir. Yazarların şu anda dünyaya yayınlamak istediklerini yansıtan bu bilgiler, zamanında hazırlanmalıdır. Zaman geçtikçe blog'un içerik yaşları yayınladığı ve daha az düzensiz hale geldiği anlaşılıyor.
  • Yorumlar: Yorum, blog yayını yazarı dışındaki kullanıcıların yazarın yazdıklarına tepki verdiği yerdir. Tuğladan bukete kadar her şey.
  • Sayfa: Biyografi bilgileri veya kullanıcıyla iletişim kurma yolları gibi statik içeriğe sahip bir sayfadır. Bunlar genellikle çok sık değişmeyen, zaman aşımına uğrayan bir bilgidir.
  • Kullanıcılar: Kullanıcı; Yazar, Yönetici veya yalnızca Okuyucu olarak hareket eden Blogger ile etkileşime geçen kişidir. Herkese açık bloglarda okuyucular anonim olabilir ancak özel bloglarda okuyucuların Blogger tarafından tanımlanması gerekir.

Blogger JSON API veri modeli

Kaynak, benzersiz tanımlayıcısı olan bağımsız bir veri varlığıdır. Blogger JSON API beş kaynak türü üzerinde çalışır:

  • Blog Kaynağı: Bir blogu temsil eder.
  • Gönderi Kaynağı: 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ğı, bir Blog Kaynağının alt öğesidir.
  • Kullanıcı Kaynağı: Anonim olmayan bir kullanıcıyı temsil eder. Bu veri, bir sayfanın, yayının veya yorumun yazarını tanımlamak için kullanılır.
Bloglar Kaynağında iki alt kaynak türü bulunur: Sayfalar ve Yayınlar. Bir Gönderi Kaynağında Yorum Kaynağı alt öğeleri olabilir.
Kaynaklar arasındaki ilişkilere genel bakış

Blogger JSON API veri modeli, koleksiyon adı verilen kaynak gruplarını temel alır:

Blog Koleksiyonu
<span="apicollection">Blog Koleksiyonu, kullanıcının erişim haklarına sahip olduğu tüm Blogları içerir. 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 Toplama, belirli bir Yayın Kaynağı'ndaki tüm Yorum Kaynakları'ndan oluşur.
Sayfa Toplama
Sayfa Koleksiyonu, belirli bir Blog Kaynağı'ndaki tüm Sayfa Kaynakları'ndan oluşur.
Kullanıcı Toplama
Kullanıcı Koleksiyonu, Blogger'daki tüm Kullanıcı Kaynakları'ndan oluşur ve bu nedenle listelenemez. Kullanıcılar, kimlikleriyle veya self tanımlayıcısını kullanarak kendi Kullanıcı Kaynaklarını (ancak başka hiç kimse) alamazlar.

Blogger JSON API işlemleri

Blogger JSON API'deki koleksiyonlar ve kaynaklarda, aşağıdaki tabloda açıklandığı gibi iki farklı yöntem çağırabilirsiniz.

İşlem Açıklama REST HTTP eşlemeleri
list Bir koleksiyondaki tüm kaynakları listeler. Bir koleksiyon URI'sinde 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 listeleme ve get işlemleri kimlik doğrulama gerektirir.

Kaynak Türü
Desteklenen Yöntemler
liste al
Bloglar evet evet
Gönderiler evet evet
Yorumlar evet evet
Sayfalar evet evet
Kullanıcı sayısı hayır evet

Arama stilleri

API'yi çağırmanın birkaç yolu vardır:

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 fiilini kullanarak bir işlem belirtir. Bir kaynağı aşağıdaki biçimdeki genel olarak benzersiz bir URI ile 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 belirli biçim şöyledir:

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'lerin tam açıklaması ve API'de desteklenen her işlemin sonuçları Blogger JSON API Referansı dokümanında özetlenir.

Aşağıda, Blogger JSON API'de nasıl çalıştığına dair birkaç örnek verilmiştir.

Kimliği doğrulanmış kullanıcının erişim haklarına sahip olduğu blogları listeleme:

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 JavaScript'teki REST'i kullanarak, callback sorgu parametresini ve bir geri çağırma işleviyle ç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 bir yayın alır (YOUR-API-KEY ile API anahtarınızı değiştirdikten sonra).

<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), 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.