Ta strona została przetłumaczona przez Cloud Translation API.

Interfejs API JSON Bloggera: pierwsze kroki

Ważne: 30 września 2024 r. zakończymy obsługę interfejsu JSON API w wersji 2.0. Aby zapewnić nieprzerwany dostęp do funkcji, zaktualizuj aplikacje, które korzystają z interfejsu JSON API w wersji 2.0, do najnowszej wersji interfejsu API. Aby pobrać najnowszą wersję, użyj linków w pasku nawigacyjnym po lewej stronie.

Z tego dokumentu dowiesz się, jak zacząć korzystać z interfejsu Blogger JSON API.

Spis treści

Wprowadzenie
Zanim zaczniesz
Informacje ogólne o interfejsie JSON API Bloggera
Styl dzwonienia
1. REST
Format danych
1. JSON

Wprowadzenie

Ten dokument jest przeznaczony dla deweloperów, którzy chcą pisać aplikacje, które mogą wchodzić w interakcje z interfejsem Blogger JSON API.

Interfejs JSON API Bloggera rozszerza wersję 2.0 interfejsu Blogger Data API. Jeśli chcesz pobierać dane z Bloggera w formacie JSON zamiast XML, użyj interfejsu Blogger JSON API. Jeśli chcesz pobrać dane w formacie XML, użyj interfejsu Blogger Data API.

Ta wersja interfejsu Blogger JSON API jest obecnie tylko do odczytu. Planujemy jednak dodać do niej obsługę odczytu i zapisu, a także inne funkcje. Możesz też poprosić o dodanie innych funkcji na Forum pomocy Bloggera.

Zanim rozpoczniesz

Załóż konto Google

Upewnij się, że masz skonfigurowane konto Google. Zalecamy używanie osobnego konta Google do celów programistycznych i testowania, aby chronić się przed przypadkową utratą danych. Jeśli masz już konto testowe, możesz przejść do interfejsu Bloggera, aby skonfigurować, edytować lub wyświetlić dane testowe.

Poznaj Bloggera

Jeśli nie znasz się na koncepcjach Bloggera, przed rozpoczęciem kodowania przeczytaj ten dokument i wypróbuj interfejs użytkownika. W tym dokumencie zakładamy, że znasz Bloggera, pojęcia związane z programowaniem stron internetowych oraz formaty danych internetowych.

Więcej informacji o autoryzowaniu żądań i identyfikowaniu aplikacji

Gdy Twoja aplikacja żąda prywatnych danych, użytkownik mający do nich dostęp musi autoryzować takie żądanie.

Gdy aplikacja żąda danych publicznych, nie musisz autoryzować żądania, ale musisz dołączyć do niego identyfikator, np. klucz interfejsu API.

Informacje o autoryzowaniu żądań i używaniu kluczy interfejsu API znajdziesz w sekcji Autoryzowanie żądań i identyfikowanie aplikacji w dokumentacji Korzystanie z interfejsu API.

Informacje ogólne o interfejsie Blogger JSON API

Koncepcje Bloggera

Blogger opiera się na 5 podstawowych koncepcjach:

Blogi: główna koncepcja interfejsu API. Blog zawiera posty i strony. To kontener z metainformacjami o blogu, takimi jak nazwa i opis.
Posty: post na blogu to element, który może opublikować autor bloga. Te informacje mają być aktualne i odzwierciedlać to, co autorzy chcą opublikować. Zdajemy sobie sprawę, że z upływem czasu treści na blogu się starzeją i tracą na aktualności.
Komentarze: komentarze to miejsce, w którym osoby inne niż autor posta na blogu mogą reagować na to, co napisał autor. Wszystko, od cegieł po bukiety.
Strony: strona to miejsce na treści statyczne, takie jak informacje biograficzne lub sposoby kontaktu z użytkownikiem. Są to zazwyczaj ponadczasowe informacje, które nie zmieniają się zbyt często.
Użytkownicy: użytkownik to osoba, która korzysta z Bloggera, niezależnie od tego, czy działa jako autor, czy jako administrator lub czy jest tylko czytelnikiem. W przypadku blogów publicznych czytelnicy mogą być anonimowi, ale w przypadku blogów prywatnych muszą być oni zidentyfikowani przez Bloggera.

Model danych Blogger JSON API

Zasób to pojedynczy element danych z unikalnym identyfikatorem. Interfejs Blogger JSON API obsługuje 5 typów zasobów:

Zasób Blogi: reprezentuje blog.
Zasób Posty: reprezentuje post. Każdy zasób Posty jest elementem potomnym zasobu Blogs.
Zasób komentarzy: reprezentuje komentarz do konkretnego posta; każdy zasób komentarzy jest elementem podrzędnym zasobu Posty.
Zasób Pages: reprezentuje stronę statyczną; każdy zasób Pages jest podrzędnym zasobu Blogs.
Zasób Users: reprezentuje nieanonimowego użytkownika. Jest on używany do identyfikowania autora strony, posta lub komentarza.

Zasób Blogi ma 2 typy zasobów podrzędnych: Strony i Posty.
Zasób Posty może mieć podrzędne zasoby Komentarze. — Omówienie relacji między zasobami

Model danych Blogger JSON API opiera się na grupach zasobów zwanych kolekcjami:

Kolekcja blogów: Kolekcja <span="apicollection">Blogs zawiera wszystkie blogi, do których użytkownik ma dostęp. Możesz wyświetlić listę blogów według użytkownika lub pobrać pojedynczy blog według identyfikatora.</span="apicollection">
Kolekcja postów: Kolekcja postów składa się ze wszystkich zasobów postów w określonym zasobie blogów.
Komentarze w kolekcji: Kolekcja komentarzy składa się ze wszystkich Zasobów komentarzy w konkretnym Zasobie postów.
Kolekcja stron: Kolekcja stron składa się ze wszystkich zasobów stron w konkretnym zasobie blogów.
Zbiór Users: Kolekcja użytkowników zawiera wszystkie Zasoby użytkowników w Bloggerze, dlatego nie można jej wyświetlić. Użytkownik może pobrać własne zasobne dla użytkowników (ale nie innych) za pomocą identyfikatora lub identyfikatora self.

Operacje interfejsu Blogger JSON API

W interfejsie Blogger JSON API możesz wywoływać 2 różne metody dotyczące kolekcji i zasobów, jak opisano w poniższej tabeli.

Operacja	Opis	Mapowania HTTP REST
list	Wyświetla listę wszystkich zasobów w kolekcji.	`GET` na URI kolekcji.
get	Pobiera konkretny zasób.	`GET` na identyfikatorze URI zasobu.

Tabela poniżej zawiera listę metod obsługiwanych przez poszczególne typy zasobów. Wszystkie operacje list i get na blogach prywatnych wymagają uwierzytelnienia.

Typ zasobu	Obsługiwane metody
	list	get
Blogi	tak	tak
Posty	tak	tak
Komentarze	tak	tak
Strony	tak	tak
Użytkownicy	nie	tak

Style połączeń

Interfejs API można wywołać na kilka sposobów:

Za pomocą interfejsu REST bezpośrednio lub za pomocą JavaScript (nie trzeba stosować kodu po stronie serwera).
za pomocą bibliotek klienta.

REST

REST to styl architektury oprogramowania, który zapewnia wygodne i spójne podejście do wysyłania żądań i modyfikowania danych.

Termin REST to skrót od Representational State Transfer. W kontekście interfejsów API Google odnosi się to używania czasowników HTTP do pobierania i modyfikowania reprezentacji danych przechowywanych przez Google.

W systemie RESTful zasoby są przechowywane w magazynie danych. Klient wysyła żądanie, aby serwer wykonał określone działanie (np. utworzenie, pobranie, zaktualizowanie lub usunięcie zasobu), a serwer wykonuje to działanie i wysyła odpowiedź, często w formie reprezentacji określonego zasobu.

W interfejsach API REST Google klient określa działanie za pomocą czasownika HTTP, takiego jak POST, GET, PUT lub DELETE. Określa on zasób za pomocą niepowtarzalnego globalnie identyfikatora URI o tym kształcie:

https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters

Wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne w ramach protokołu HTTP, co umożliwia korzystanie z przechowywania danych w pamięci podręcznej i optymalizuje działanie w rozproszonej infrastrukturze sieci.

Przydatne mogą być definicje metod w dokumentacji standardów HTTP 1.1. Obejmują one specyfikacje GET, POST, PUT i DELETE.

Interfejs REST w interfejsie API typu JSON Bloggera

Obsługiwane operacje Bloggera są mapowane bezpośrednio na czasowniki HTTP REST, zgodnie z opisem w sekcji Operacje interfejsu Blogger JSON API.

Format identyfikatorów URI interfejsu API Bloggera w formacie JSON:

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

Pełne wyjaśnienie używania identyfikatorów URI oraz wyniki każdej obsługiwanej operacji w interfejsie API znajdziesz w dokumencie Blogger JSON API Reference (w języku angielskim).

Oto kilka przykładów działania interfejsu Blogger JSON API.

Wyświetla listę blogów, do których uwierzytelniony użytkownik ma uprawnienia dostępu:

GET https://www.googleapis.com/blogger/v2/users/self/blogs?key=YOUR-API-KEY

Pobierz posty z bloga code.blogger.com (który ma identyfikator bloga 3213900):

GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY

REST z JavaScript

Interfejs API Blogger JSON możesz wywoływać za pomocą interfejsu REST z poziomu kodu JavaScript, używając parametru zapytania callback i funkcji wywołania zwrotnego. Dzięki temu możesz pisać rozbudowane aplikacje wyświetlające dane z Bloggera bez konieczności pisania kodu po stronie serwera.

W tym przykładzie pobieramy wpis z bloga code.blogger.com (po zastąpieniu wartości YOUR-API-KEY swoim kluczem API).

<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>

Format danych

JSON

JSON (JavaScript Object Notation) to powszechny format danych niezależny od języka, który zapewnia prostą tekstową reprezentację dowolnych struktur danych. Więcej informacji znajdziesz na stronie json.org.