Blogger API: Başlarken (original) (raw)
Bu dokümanda, Blogger API'yi kullanmaya nasıl başlayacağınız açıklanmaktadır.
Başlamadan önce
Bir Google Hesabı edinin
Oluşturulan bir Google Hesabınız olduğundan emin olun. Yanlışlıkla veri kaybı yaşamamak için geliştirme ve test amacıyla ayrı bir Google Hesabı kullanmanızı öneririz. Hâlihazırda 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ıma
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 belgede Blogger, web programlama kavramları ve web veri biçimleri hakkında bilgi sahibi olduğunuz varsayılı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 istekle birlikte API anahtarı gibi bir tanımlayıcı eklenmesi gerekir.
İstekleri yetkilendirme ve API anahtarlarını kullanma hakkında bilgi edinmek için API'yi kullanma dokümanındaki İstekleri yetkilendirme ve uygulamanızı tanımlama bölümüne bakın.
Blogger API arka planı
Blogger kavramları
Blogger beş temel kavram üzerine kurulmuştur:
- Bloglar: API'nin kök kavramı. Bir blogun yayınları ve sayfaları vardır. 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 sunulması ve yazarların şu anda dünyaya yayınlamak istedikleri içerikleri yansıtması amaçlanmıştır. Zaman geçtikçe blog yayınlarının içeriğinin eskidiği ve alakasız hale geldiği anlaşılmaktadır.
- Yorumlar: Yorum, blog yayınının yazarı dışındaki kişilerin, yazarın yazdıklarına tepki verdiği yerdir. Tuğlalardan buketlere kadar her şey.
- Sayfalar: Sayfa, biyografik bilgiler veya kullanıcıyla iletişim kurma yöntemleri gibi statik içeriklere yönelik bir yerdir. Bunlar genellikle zamana bağlı olmayan ve çok sık değişmeyen bilgilerdir.
- Kullanıcılar: Kullanıcı; Yazar, Yönetici veya yalnızca Okuyucu gibi Blogger ile etkileşimde bulunan kişidir. Herkese açık bloglarda okuyucular anonim olabilir ancak özel bloglarda okuyucunun Blogger tarafından tanımlanması gerekir.
Blogger API veri modeli
Kaynak, benzersiz bir tanımlayıcıya sahip bağımsız bir veri varlığıdır. Blogger JSON API beş tür kaynak üzerinde çalışır:
- Blog kaynağı: Bir blogu temsil eder.
- Yayın kaynağı: Bir yayını temsil eder. Her yayın kaynağı, bir blog 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, bir sayfanın, yayının veya yorumun Yazarını tanımlamak için kullanılır.
Kaynaklar arasındaki ilişkilere genel bakış
Blogger 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 bloglardan oluşur. Blogları kullanıcıya göre listeleyebilir veya kimliğe göre tek bir blog alabilirsiniz.</span="apicollection">
Gönderi koleksiyonu
Gönderi koleksiyonu, belirli bir blog kaynağı içindeki tüm yayın kaynaklarından oluşur.
Yorum koleksiyonu
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ından oluşur ve bu nedenle listelenemez. Bir kullanıcı, kendi kullanıcı kaynağını (ancak başkasının kaynağını) kimliğe göre veya self tanımlayıcısını kullanarak alabilir.
Blogger API işlemleri
Blogger API'de, aşağıdaki tabloda açıklandığı üzere koleksiyonlar ve kaynaklarda farklı yöntemleri ç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'daki GET. |
| getByUrl | Bir kaynağı URL ile arayarak alır. | GET ile birlikte parametre olarak iletilen URL. |
| getByPath | Bir kaynağı yoluna göre arayarak alır. | GET. Yol bir parametre olarak aktarılır. |
| listByUser | Kullanıcının sahip olduğu kaynakları listeler. | Kullanıcıya ait bir koleksiyonda GET. |
| search | Bir sorgu parametresine göre kaynak arayın. | Arama URL'sinde GET ve sorgu parametre olarak iletildi. |
| ekle | Bir koleksiyonda kaynak oluşturun. | Koleksiyon URI'sında POST. |
| sil | Bir kaynağı siler. | Kaynak URI'daki DELETE. |
| yama | Yama semantiğini kullanarak bir kaynağı güncelleme. | Kaynak URI'daki PATCH. |
| güncelle | Bir kaynak güncelleme. | Kaynak URI'daki PUT. |
Aşağıdaki tabloda, her kaynak türünün hangi yöntemleri desteklediği gösterilmektedir. Özel bloglardaki tüm list ve get işlemleri kimlik doğrulama gerektirir.
| Kaynak Türü | Desteklenen Yöntemler | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| liste | alın | getByUrl | getByPath | listByUser | arama | ekle | sil | yama | güncelleme | |
| Bloglar | no | evet | evet | no | evet | no | hayır | hayır | hayır | no |
| Gönderiler | evet | evet | no | evet | no | evet | evet | evet | evet | evet |
| Yorumlar | evet | evet | no | hayır | hayır | hayır | hayır | hayır | hayır | no |
| Sayfalar | evet | evet | no | hayır | hayır | hayır | hayır | hayır | hayır | no |
| Kullanıcı sayısı | no | evet | no | hayır | hayır | hayır | hayır | hayır | hayır | no |
Arama stilleri
API'yi çağırmanın birkaç yolu vardır:
- REST'i doğrudan veya JavaScript'ten kullanma (sunucu tarafı kodu 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, bir işlemi HTTP fiili kullanarak (ör. POST, GET, PUT veya DELETE) belirtir. Bir kaynağı, aşağıdaki biçimdeki küresel 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 API'de REST
Desteklenen Blogger işlemleri, Blogger API işlemlerinde açıklandığı gibi doğrudan REST HTTP fiilleriyle eşlenir.
Blogger API URI'lerinin özel biçimi şunlardır:
https://www.googleapis.com/blogger/v3/users/userId https://www.googleapis.com/blogger/v3/users/self https://www.googleapis.com/blogger/v3/users/userId/blogs https://www.googleapis.com/blogger/v3/users/self/blogs https://www.googleapis.com/blogger/v3/blogs/blogId https://www.googleapis.com/blogger/v3/blogs/byurl https://www.googleapis.com/blogger/v3/blogs/blogId/posts https://www.googleapis.com/blogger/v3/blogs/blogId/posts/bypath https://www.googleapis.com/blogger/v3/blogs/blogId/posts/search https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments https://www.googleapis.com/blogger/v3/blogs/blogId/posts/postId/comments/commentId https://www.googleapis.com/blogger/v3/blogs/blogId/pages https://www.googleapis.com/blogger/v3/blogs/blogId/pages/pageId
Kullanılan URI'ların tam açıklaması ve API'de desteklenen her bir işlemin sonuçları, Blogger API Referansı belgesinde özetlenmiştir.
Örnekler
Kimliği doğrulanan kullanıcının erişim hakkına sahip olduğu blogları listeleyin:
GET https://www.googleapis.com/blogger/v3/users/self/blogs?key=YOUR-API-KEY
Blog kimliği 3213900 olan code.blogger.com blogundaki yayınları alın:
GET https://www.googleapis.com/blogger/v3/blogs/**3213900**?key=YOUR-API-KEY
JavaScript'ten REST
Blogger API'yi, callback sorgu parametresini ve bir geri çağırma işlevi sağlayarak JavaScript'ten çağırabilirsiniz. Tarayıcı komut dosyasını yüklediğinde, geri çağırma işlevi yürütülür ve geri çağırma işlevine yanıt sağlanır. Bu yaklaşım, sunucu tarafı kodu gerektirmeden Blogger verilerini görüntüleyen zengin uygulamalar yazmanıza olanak tanır.
Aşağıdaki örnek, YOUR-API-KEY yerine API anahtarınızın gelmesinden sonra code.blogger.com blogundan bir yayın getirmektedir.
Blogger API ExampleVeri biçimi
JSON
JSON (JavaScript Object Notation - JavaScript Nesne Gösterimi), 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.