Önemli: JSON API 2.0 sürümüne yönelik desteği 30 Eylül 2024'te sonlandıracağız. İşlevselliğin etkinlenmemesi için JSON API'nin 2.0 sürümünü 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, RESTful çağrı stilini kullanarak Blogger JSON API'nin ortak özelliklerinin nasıl kullanılacağı açıklanmaktadır.
İçindekiler
Giriş
Bu doküman, Blogger JSON API ile etkileşim kurabilen uygulamalar yazmak isteyen geliştiriciler için hazırlanmıştır. Blogger, yayıncıların insanların düşüncelerini devamlı bir yayında yayınlamalarına olanak sağlayan web siteleri oluşturmak .
Blogger kavramlarına aşina değilseniz kodlamaya başlamadan önce Başlarken bölümünü okumalısınız.
İstekleri yetkilendirme ve uygulamanızı tanımlama
Uygulamanız tarafından Blogger JSON API'sine gönderilen her isteğin Google'a uygulamanızı tanımlaması gerekir. Verilerinizi tanımlamanın iki yolu vardır: uygulama: OAuth 2.0 jetonu kullanarak ayrıca isteği yetkilendirdiğinde) ve/veya uygulamanın API anahtarını kullanarak. Hangi seçenekleri kullanacağınızı belirlemek için aşağıdaki adımları uygulayın:
- İstek yetkilendirme gerektiriyorsa (ör. bir kişinin gizli verilerine ilişkin istek) uygulama, istekle birlikte bir OAuth 2.0 jetonu sağlamalıdır. Uygulama API anahtarını da sağlayabilir ancak .
- İstek yetkilendirme gerektirmiyorsa (ör. herkese açık veriler için istek) uygulama, API anahtarını veya OAuth 2.0 jetonunu ya da sizin için en uygun seçeneği (ikisi birden) sağlamalıdır.
Yetkilendirme protokolleri hakkında
Uygulamanız, istekleri yetkilendirmek için OAuth 2.0 kullanmalıdır. Başka hiçbir yetkilendirme protokolü desteklenmez.
Not: Blogger JSON API şu anda günlük kaydını desteklememektedir. Aynı anda veri erişimi (karma) veya alan genelinde yetkilerin verilmesi (2LO).
İstekleri OAuth 2.0 ile yetkilendirme
Herkese açık olmayan kullanıcı verileri için Blogger JSON API'ye yapılan istekler yetkilendirilmelidir kimlik doğrulaması yapılmış bir kullanıcı tarafından gerçekleştirilir.
Yetkilendirme sürecinin veya "akış"ın ayrıntıları, OAuth 2.0 için değişiklik gösterir biraz da kullandığınız uygulamanın türüne göre. Aşağıdaki genel işlem tüm uygulama türleri için geçerlidir:
- Uygulamanızı oluştururken Google'a kaydedersiniz. Google ardından istemci kimliği ve istemci kimliği gibi daha sonra ihtiyaç duyacağınız bilgileri sır.
- Google API'lerinin Hizmetler bölmesinde Blogger JSON API'yi etkinleştirin Konsol. (API, Konsolu'nda listelenmemişse bu adımı atlayın.)
- Uygulamanız kullanıcı verilerine erişmesi gerektiğinde Google'dan belirli bir erişim kapsamı ister.
- Google, kullanıcıya bir OAuth iletişim kutusu göstererek kullanıcıdan (uygulamanıza bazı verileri istemesi için yetki vermelisiniz).
- Kullanıcı onaylarsa Google, uygulamanız için kısa bir ömür erişim jetonundan yararlanabilirsiniz.
- Uygulamanız, erişim jetonunu isteği gönderin.
- Google, isteğinizin ve jetonun geçerli olduğuna karar verirse isteyeceğiz.
Bazı akışlar, yenileme yöntemini kullanmak gibi ek adımlar içerir. yeni erişim jetonları almak için. Ayrıntılı bilgi için akışlar için Google'ın OAuth 2.0 dokümanlarına bakın.
Aşağıda, Blogger JSON API'si:
https://www.googleapis.com/auth/blogger
OAuth 2.0 kullanarak erişim isteğinde bulunmak için uygulamanızın kapsama dahil olması gerekir başvuru sırasında Google'ın sağladığı bilgilerin yanı sıra kaydı (istemci kimliği ve/veya istemci gizli anahtarı gibi).
İpucu: Google API'leri istemci kitaplıkları, yetkilendirme işleminin bazı adımlarını sizin yerinize gerçekleştirebilir. Hem çeşitli programlama dilleri; Kütüphaneler ve Örnekler sayfasında inceleyebilirsiniz.
API anahtarı edinme ve kullanma
Herkese açık veriler için Blogger JSON API'sine yapılan isteklerin bir tanımlayıcıyla (API anahtarı veya kimlik doğrulama jetonu olabilir) birlikte gönderilmesi gerekir.
API anahtarı edinmek için API'ler Konsolu'nu ziyaret edin. Hizmetlerde bölme, [api_name] öğesini etkinleştirin; ve Hizmet Şartları görünürse, okuyup kabul edin. oluşturabilirsiniz.
Ardından API erişimi bölmesine gidin. API anahtarı, söz konusu bölmenin alt kısmına yakın bir yerde: başlıklı makaleyi inceleyin.
API anahtarınız olduktan sonra uygulamanız, tüm istek URL'lerine key=yourAPIKey
sorgu parametresini ekleyebilir.
API anahtarı, URL'lere yerleştirmek için güvenlidir; herhangi bir kodlama yapmanız gerekmez.
Bloglarla Çalışma
Blog Alma
Belirli bir Blog Kaynağı hakkındaki bilgileri, HTTP
Blog'un URI'sına GET
isteği. Blog Kaynaklarının URI'si aşağıdaki biçimdedir:
https://www.googleapis.com/blogger/v2/blogs/blogId
İstek
Örnek:
GET https://www.googleapis.com/blogger/v2/blogs/2399953&key=YOUR-API-KEY
Herkese açık bir Blog almak için kullanıcının kimliğinin doğrulanması gerekmez.
bu ek bağlamla Authorization
HTTP üst bilgisini sağlamak zorunda değildir
GET
isteği; ancak bu başlığı sağlamazsanız bir API anahtarı sağlamanız gerekir.
Blogger'da kimlik doğrulama gerektiren özel bloglar da vardır.
Yanıt
İstek başarılı olursa sunucu bir HTTP 200 OK
durum kodu ve blog verileriyle yanıt verir:
200 OK { "kind": "blogger#blog", "id": "2399953", "name": "Blogger Buzz", "description": "The Official Buzz from Blogger at Google", "published": "2007-04-23T22:17:29.261Z", "updated": "2011-08-02T06:01:15.941Z", "url": "http://buzz.blogger.com/", "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953", "posts": { "totalItems": 494, "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts" }, "pages": { "totalItems": 2, "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/pages" }, "locale": { "language": "en", "country": "", "variant": "" } }
Kullanıcının Bloglarını Alma
Blog Koleksiyonu URI'sine bir HTTP GET
isteği göndererek kullanıcının bloglarının listesini alabilirsiniz:
https://www.googleapis.com/blogger/v2/users/userId/blogs
İstek
Kullanıcının bloglarını listeleyen bir GET
isteği örneğini aşağıda bulabilirsiniz:
GET https://www.googleapis.com/blogger/v2/users/self/blogs
Authorization: /* OAuth 2.0 token here */
Not: Kullanıcının kimliği şu şekilde doğrulanmalıdır:
kendi bloglarını listeler. Bu nedenle Authorization
HTTP
GET
isteğini içeren üstbilgiyi gösterir.
Yanıt
İstek başarılı olursa sunucu bir HTTP ile yanıt verir
200 OK
durum kodu ve kullanıcıya ait
bloglar:
200 OK { "kind": "blogger#blogList", "items": [ { "kind": "blogger#blog", "id": "4967929378133675647", "name": "Brett's Test Blawg", "description": "", "published": "2010-10-06T23:33:31.662Z", "updated": "2011-08-08T06:50:02.005Z", "url": "http://brettmorgan-test-blawg.blogspot.com/", "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647", "posts": { "totalItems": 13, "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/posts" }, "pages": { "totalItems": 1, "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages" }, "locale": { "language": "en", "country": "", "variant": "" } } ] }
Yayınlarla çalışma
Blog'dan Yayın Alma
Belirli bir Blog'daki Yayınların listesini
Yayın Koleksiyonu URI'si için GET
isteği. Yayınlara ilişkin URI
Koleksiyon aşağıdaki biçimdedir:
https://www.googleapis.com/blogger/v2/blogs/blogId/posts
İstek
Örnek:
GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts&key=YOUR-API-KEY
Bir kullanıcının herkese açık bir Blog'dan Yayınları almak için kimlik doğrulamasının yapılmış olması gerekmediğinden
bu ek bağlamla Authorization
HTTP üst bilgisini sağlamak zorunda değildir
GET
isteği; ancak bu başlığı sağlamazsanız bir API anahtarı sağlamanız gerekir.
Blogger'da kullanılan özel Blog'lar da kimlik doğrulama.
Yanıt
İstek başarılı olursa sunucu, HTTP 200 OK
durum kodu ve Yayınlar listesi ile yanıt verir:
200 OK { "kind": "blogger#postList", "nextPageToken": "CgkIChiAkceVjiYQ0b2SAQ", "prevPageToken": "CgkIChDBwrK3mCYQ0b2SAQ", "items": [ { "kind": "blogger#post", "id": "7706273476706534553", "blog": { "id": "2399953" }, "published": "2011-08-01T19:58:00.000Z", "updated": "2011-08-01T19:58:51.947Z", "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html", "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553", "title": "Latest updates, August 1st", "content": "elided for readability", "author": { "id": "401465483996", "displayName": "Brett Wiltshire", "url": "http://www.blogger.com/profile/01430672582309320414", "image": { "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png" } }, "replies": { "totalItems": "0", "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments" } }, { "kind": "blogger#post", "id": "6069922188027612413", elided for readability } ] }
Belirli Bir Yayını Alma
Blog'daki belirli bir Yayını
Yayın Kaynağı URI'sine GET
isteği. Yayınlara ilişkin URI
Kaynak şu biçimdedir:
https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId
İstek
Örnek:
GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553&key=YOUR-API-KEY
Bir kullanıcının herkese açık bir Blog'dan Yayınları almak için kimlik doğrulamasının yapılmış olması gerekmediğinden
bu ek bağlamla Authorization
HTTP üst bilgisini sağlamak zorunda değildir
GET
isteği; ancak bu başlığı sağlamazsanız bir API anahtarı sağlamanız gerekir.
Blogger'da kullanılan özel Blog'lar da kimlik doğrulama.
Yanıt
İstek başarılı olursa sunucu, HTTP 200 OK
durum kodu ve Yayın'ın içeriğiyle yanıt verir:
200 OK { "kind": "blogger#post", "id": "7706273476706534553", "blog": { "id": "2399953" }, "published": "2011-08-01T19:58:00.000Z", "updated": "2011-08-01T19:58:51.947Z", "url": "http://buzz.blogger.com/2011/08/latest-updates-august-1st.html", "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553", "title": "Latest updates, August 1st", "content": "elided for readability", "author": { "id": "401465483996", "displayName": "Brett Wiltshire", "url": "http://www.blogger.com/profile/01430672582309320414", "image": { "url": "http://4.bp.blogspot.com/_YA50adQ-7vQ/S1gfR_6ufpI/AAAAAAAAAAk/1ErJGgRWZDg/S45/brett.png" } }, "replies": { "totalItems": "0", "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/7706273476706534553/comments" } }
Yorumlarla Çalışma
Gönderideki Yorumları Alma
Yorumlar Koleksiyonu URI'sine bir GET
isteği göndererek bir yayına ait yorumların listesini alabilirsiniz. Yorum koleksiyonunun URI'si aşağıdaki biçimdedir:
https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments
İstek
Örnek:
GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments&key=YOUR-API-KEY
Herkese açık bir Blog'dan Yorum almak için kullanıcının kimliğinin doğrulanması gerekmez.
bu ek bağlamla Authorization
HTTP üst bilgisini sağlamak zorunda değildir
GET
isteği; ancak bu başlığı sağlamazsanız bir API anahtarı sağlamanız gerekir.
Blogger'da kullanılan özel Blog'lar da kimlik doğrulama.
Yanıt
İstek başarılı olursa sunucu bir HTTP 200 OK
durum kodu ve yorumların listesini döndürür:
200 OK { "kind": "blogger#commentList", "nextPageToken": "CgkIFBDwjvDXlyYQ0b2SARj9mZe9n8KsnlQ", "prevPageToken": "CgkIFBisvMGRlyYQ0b2SARj9mZe9n8KsnlQ", "items": [ { "kind": "blogger#comment", "id": "9200761938824362519", "post": { "id": "6069922188027612413" }, "blog": { "id": "2399953" }, "published": "2011-07-28T19:19:57.740Z", "updated": "2011-07-28T21:29:42.015Z", "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519", "content": "elided", "author": { "id": "530579030283", "displayName": "elided", "url": "elided", "image": { "url": "elided" } } }, { "kind": "blogger#comment", "id": "400101178920857170", elided for readability } ] }
Belirli bir yorumu alma
Yorumlar Kaynak URI'sine GET
isteği göndererek bir yayındaki belirli bir yorumu alabilirsiniz. Yorum kaynağının URI'si aşağıdaki biçimdedir:
https://www.googleapis.com/blogger/v2/blogs/blogId/posts/postId/comments/commentId
İstek
Örnek:
GET https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519&key=YOUR-API-KEY
Herkese açık bir Blog'dan Yorum almak için kullanıcının kimliğinin doğrulanması gerekmez.
bu ek bağlamla Authorization
HTTP üst bilgisini sağlamak zorunda değildir
GET
isteği; ancak bu başlığı sağlamazsanız bir API anahtarı sağlamanız gerekir.
Blogger'da kullanılan özel Blog'lar da kimlik doğrulama.
Yanıt
İstek başarılı olursa sunucu, HTTP 200 OK
durum kodu ve yorum verileriyle yanıt verir:
200 OK { "kind": "blogger#comment", "id": "9200761938824362519", "post": { "id": "6069922188027612413" }, "blog": { "id": "2399953" }, "published": "2011-07-28T19:19:57.740Z", "updated": "2011-07-28T21:29:42.015Z", "selfLink": "https://www.googleapis.com/blogger/v2/blogs/2399953/posts/6069922188027612413/comments/9200761938824362519", "content": "elided", "author": { "id": "530579030283", "displayName": "elided", "url": "elided", "image": { "url": "elided" } } }
Sayfalarla Çalışma
Bir Blogun Sayfalarını Alma
Sayfalar Koleksiyonu URI'sine GET
isteği göndererek bir blogun Sayfalar listesini alabilirsiniz. Sayfaların URI'si
Koleksiyon aşağıdaki biçimdedir:
https://www.googleapis.com/blogger/v2/blogs/blogId/pages
İstek
Örnek:
GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages&key=YOUR-API-KEY
Kullanıcının, herkese açık bir blogdaki sayfaları almak için kimliğinin doğrulanması gerekmediğinden bu istekle birlikte Authorization
HTTP üst bilgisini sağlamanız gerekmezGET
. Ancak bu üstbilgiyi sağlamazsanız API anahtarı sağlamanız gerekir.
Blogger'da kullanılan özel Blog'lar da kimlik doğrulama.
Yanıt
İstek başarılı olursa sunucu bir HTTP ile yanıt verir
200 OK
durum kodu ve Sayfa listesi:
200 OK { "kind": "blogger#pageList", "items": [ { "kind": "blogger#page", "id": "273541696466681878", "blog": { "id": "4967929378133675647" }, "published": "2011-07-14T16:16:00.000Z", "updated": "2011-07-14T16:16:23.602Z", "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html", "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878", "title": "Static Content", "content": "elided for readability", "author": { "id": "901569848744", "displayName": "brett", "url": "http://www.blogger.com/profile/16258312240222542576", "image": { "url": "https://resources.blogblog.com/img/b16-rounded.gif" } } } ] }
Belirli Bir Sayfayı Alma
Blog'dan belirli bir Sayfayı almak için
Sayfalar Kaynağı URI'sine GET
isteği. Sayfaların URI'si
Kaynak şu biçimdedir:
https://www.googleapis.com/blogger/v2/blogs/blogId/pages/pageId
İstek
Örnek:
GET https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878&key=YOUR-API-KEY
Kullanıcının, herkese açık bir blogdaki sayfaları almak için kimliğinin doğrulanması gerekmediğinden bu istekle birlikte Authorization
HTTP üst bilgisini sağlamanız gerekmezGET
. Ancak bu üstbilgiyi sağlamazsanız API anahtarı sağlamanız gerekir.
Blogger'da kullanılan özel Blog'lar da kimlik doğrulama.
Yanıt
İstek başarılı olursa sunucu bir HTTP ile yanıt verir
200 OK
durum kodu ve sayfa verileri:
200 OK { "kind": "blogger#page", "id": "273541696466681878", "blog": { "id": "4967929378133675647" }, "published": "2011-07-14T16:16:00.000Z", "updated": "2011-07-14T16:16:23.602Z", "url": "http://brettmorgan-test-blawg.blogspot.com/p/static-content.html", "selfLink": "https://www.googleapis.com/blogger/v2/blogs/4967929378133675647/pages/273541696466681878", "title": "Static Content", "content": "elided for readability", "author": { "id": "901569848744", "displayName": "brett", "url": "http://www.blogger.com/profile/16258312240222542576", "image": { "url": "https://resources.blogblog.com/img/b16-rounded.gif" } } }
Kullanıcılarla Çalışma
Kullanıcıyı alma
Bir kullanıcının bilgilerini HTTP GET
isteği göndererek alabilirsiniz
öğesine gidersiniz:
https://www.googleapis.com/blogger/v2/users/userId
İstek
Kullanıcının bloglarını listeleyen bir GET
isteği örneğini aşağıda bulabilirsiniz:
GET https://www.googleapis.com/blogger/v2/users/self
Authorization: /* OAuth 2.0 token here */
Not: Kullanıcının kimliği şu şekilde doğrulanmalıdır:
kendi bilgilerini listeledikleri için Authorization
HTTP
GET
isteğini içeren üstbilgiyi gösterir.
Yanıt
İstek başarılı olursa sunucu bir HTTP ile yanıt verir
200 OK
durum kodu ve kullanıcının
bloglar:
200 OK { "kind": "blogger#user", "id": "901569848744", "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744", "blogs": { "selfLink": "https://www.googleapis.com/blogger/v2/users/901569848744/blogs" } }
Standart sorgu parametreleri
Aşağıdaki sorgu parametreleri, Blogger API'lerindeki tüm yöntemler ve tüm kaynaklarla kullanılabilir.
Tüm Blogger API'leri işlemleri için geçerli olan sorgu parametreleri, Sistem Parametreleri.