Ważne: 30 września 2024 r. przestaniemy obsługiwać interfejs JSON API w wersji 2.0. Aby zapewnić nieprzerwaną funkcjonalność, zaktualizuj aplikacje, które korzystają z interfejsu JSON API w wersji 2.0, do najnowszej wersji. Aby uzyskać dostęp do najnowszej wersji, użyj linków na pasku nawigacyjnym po lewej stronie.
Ten dokument wyjaśnia, jak zacząć korzystać z interfejsu API JSON Bloggera.
Spis treści
Wstęp
Ten dokument jest przeznaczony dla programistów, którzy chcą tworzyć aplikacje mogące współpracować z interfejsem JSON API Bloggera.
Interfejs JSON API Bloggera rozszerza wersję 2.0 interfejsu Blogger Data API. Jeśli chcesz pobierać dane z Bloggera w formacie JSON, a nie XML, użyj interfejsu JSON API Bloggera. Jeśli chcesz pobrać dane w formacie XML, użyj interfejsu API danych Bloggera.
Ta wersja interfejsu JSON API Bloggera jest obecnie dostępna tylko do odczytu. Planujemy jednak dodać do niej funkcje do odczytu i zapisu oraz inne funkcje. Jeśli chcesz poprosić o inne funkcje, odwiedź Forum pomocy Bloggera.
Zanim zaczniesz
Załóż konto Google
Upewnij się, że masz skonfigurowane konto Google. Zalecamy używanie osobnego konta Google do celów programistycznych i testowych, aby chronić się przed przypadkową utratą danych. Jeśli masz już konto testowe, nie musisz nic robić. Możesz otworzyć interfejs Bloggera, aby skonfigurować, edytować lub wyświetlić dane testowe.
Poznaj Bloggera
Jeśli nie masz doświadczenia z pojęciami związanymi z Bloggerem, przed rozpoczęciem tworzenia kodu przeczytaj ten dokument i poeksperymentuj z interfejsem. Zakładamy w nim, że znasz Bloggera, pojęcia związane z programowaniem stron internetowych oraz formaty danych z sieci.
Dowiedz się więcej o autoryzowaniu żądań i identyfikowaniu aplikacji
Gdy Twoja aplikacja żąda prywatnych danych, użytkownik mający dostęp do tych danych musi autoryzować takie żądanie.
Gdy Twoja aplikacja żąda danych publicznych, żądanie nie wymaga autoryzacji, ale musi mu towarzyszyć identyfikator, np. klucz interfejsu API.
Informacje o autoryzowaniu żądań i używaniu kluczy interfejsu API znajdziesz w sekcji Autoryzacja żądań i identyfikowanie aplikacji w dokumencie Korzystanie z interfejsu API.
Tło interfejsu API JSON Bloggera
Pojęcia związane z Bloggerem
Blogger opiera się na 5 podstawowych koncepcjach:
- Blogi: główna koncepcja interfejsu API. Blog zawiera posty i strony. Jest to kontener na metainformacje o blogu, takie jak nazwa i opis.
- Posty: post na blogu to element do publikowania utworzony przez autora bloga. Te informacje powinny być aktualne i odzwierciedlać to, co autorzy chcą opublikować teraz na całym świecie. To znaczy, że z upływem czasu treść postów na blogu starzeje się i staje się coraz mniej rzetelna.
- Komentarze: to miejsce, w którym inne osoby niż autor posta na blogu reagują na to, co napisał dany autor. Wszystko, od cegieł po bukiety.
- Strony: strona to miejsce na treści statyczne, np. informacje biograficzne lub informacje o sposobach kontaktu z użytkownikiem. Są to informacje ponadczasowe, które nie zmieniają się zbyt często.
- Użytkownicy: użytkownik to osoba, która korzysta z Bloggera w roli autora, administratora lub tylko czytelnika. Czytelnicy blogów publicznych mogą być anonimowi, ale na blogach prywatnych czytelnicy muszą zostać zidentyfikowani przez Bloggera.
Model danych JSON API Bloggera
Zasób to pojedyncza encja danych o unikalnym identyfikatorze. Interfejs JSON API Bloggera działa na 5 typach zasobów:
- Zasób blogów: reprezentuje bloga.
- Zasób postów: reprezentuje posta. Każdy zasób Posty jest podrzędny wobec zasobu Blogs.
- Zasób komentarzy: reprezentuje komentarz do konkretnego posta. Każdy zasób Komentarze jest podrzędny wobec zasobu Postów.
- Zasób stron: reprezentuje stronę statyczną; każdy zasób Pages jest podrzędny względem zasobu Blogs.
- Zasób dla użytkowników: reprezentuje użytkownika nieanonimowego. Służy on do identyfikowania autora strony, posta lub komentarza.
Model danych JSON API Bloggera opiera się na grupach zasobów nazywanych zbiorami:
- Kolekcja Blogi
- <span="apicollection">Kolekcja blogów to wszystkie blogi, do których użytkownik ma dostęp. Blogi można wyświetlać 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 dotyczących postów w ramach określonego zasobu na blogu.
- Kolekcja komentarzy
- Kolekcja komentarzy składa się ze wszystkich zasobów dotyczących komentarzy w danym zasobie do publikowania postów.
- Kolekcja stron
- Kolekcja stron składa się ze wszystkich zasobów stron w ramach określonego zasobu Blogów.
- Kolekcja Użytkownicy
- Kolekcja użytkowników składa się ze wszystkich zasobów użytkowników w Bloggerze, więc nie można jej tam umieścić. Użytkownik może pobierać własny zasób użytkowników (ale nienależący do kogoś innego) za pomocą identyfikatora lub identyfikatora
self.
Operacje interfejsu API JSON Bloggera
W interfejsie API JSON Bloggera możesz wywołać 2 różne metody w zbiorach i zasobach zgodnie z opisem w poniższej tabeli.
| Operacja | Opis | Mapowania HTTP REST |
|---|---|---|
| list | Wyświetla listę wszystkich zasobów w kolekcji. | GET o identyfikatorze URI kolekcji. |
| pobierz | Pobiera określony zasób. | GET o identyfikatorze URI zasobu. |
W tabeli poniżej znajdziesz metody obsługiwane przez poszczególne typy zasobów. Wszystkie operacje listy i pobierania operacji na blogach prywatnych wymagają uwierzytelniania.
Typ zasobu |
Obsługiwane metody |
|
|---|---|---|
| lista | Pobierz | |
| Blogi | tak | tak |
| Posty | tak | tak |
| komentarzami. | tak | tak |
| Strony | tak | tak |
| Użytkownicy | nie | tak |
Style połączeń
Interfejs API można wywołać na kilka sposobów:
- Używając kodu REST bezpośrednio lub za pomocą JavaScript (nie jest wymagany kod po stronie serwera)
- przy użyciu bibliotek klienta,
REST
REST to styl architektury oprogramowania zapewniający wygodne i spójne podejście do żądania i modyfikowania danych.
Termin REST to skrót od „Representational State Transfer”. W kontekście interfejsów API Google oznacza korzystanie z czasowników HTTP do pobierania i modyfikowania reprezentacji danych przechowywanych przez Google.
W systemie REST zasoby są przechowywane w magazynie danych. Klient wysyła żądanie, aby serwer wykonał określone działanie (takie jak utworzenie, pobranie, zaktualizowanie lub usunięcie zasobu), a serwer je wykonuje i wysyła odpowiedź, często w formie reprezentacji określonego zasobu.
W interfejsach API Google typu REST klient określa działanie za pomocą czasownika HTTP, takiego jak POST, GET, PUT czy DELETE. Zasób określa zasób za pomocą unikalnego globalnie identyfikatora URI o takiej postaci:
https://www.googleapis.com/apiName/apiVersion/resourcePath?parameters
Wszystkie zasoby interfejsu API mają unikalne identyfikatory URI dostępne przez HTTP, dlatego REST umożliwia buforowanie danych i jest zoptymalizowany pod kątem współpracy z rozproszoną infrastrukturą sieci.
Definicje metod można znaleźć w dokumentacji standardów HTTP 1.1. Zawierają one specyfikacje GET, POST, PUT i DELETE.
REST w interfejsie API JSON Bloggera
Obsługiwane operacje Bloggera są mapowane bezpośrednio na czasowniki HTTP REST zgodnie z opisem w sekcji Operacje interfejsu API JSON Bloggera.
Szczegółowy format identyfikatorów URI interfejsu API JSON Bloggera:
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żywanych identyfikatorów URI i wyniki poszczególnych obsługiwanych operacji w interfejsie API znajdziesz w dokumencie Blogger JSON API.
Oto kilka przykładów, jak to działa w interfejsie API JSON Bloggera.
Wyświetl 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
Uzyskaj dostęp do postów na blogu code.blogger.com (identyfikator bloga o identyfikatorze 3213900):
GET https://www.googleapis.com/blogger/v2/blogs/3213900?key=YOUR-API-KEY
REST z JavaScriptu
Interfejs API Bloggera w formacie JSON możesz wywołać interfejs API REST z poziomu JavaScriptu, używając parametru zapytania callback i funkcji wywołania zwrotnego. Pozwala to tworzyć zaawansowane aplikacje wyświetlające dane z Bloggera bez konieczności pisania kodu po stronie serwera.
Poniższy przykład powoduje pobranie posta z bloga code.blogger.com (po zastąpieniu YOUR-API-KEY kluczem interfejsu 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 popularny format danych niezależny od języka, który przedstawia w prosty sposób tekstowe struktury danych. Więcej informacji znajdziesz na stronie json.org.