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

Interfejs API JSON Bloggera: pierwsze kroki

Ten dokument wyjaśnia, jak zacząć korzystać z interfejsu API JSON Bloggera.

Spis treści

Wprowadzenie
Zanim zaczniesz
Tło interfejsu API JSON Bloggera
Styl połączenia
1. REST
Format danych
1. JSON

Wprowadzenie

Ten dokument jest przeznaczony dla programistów, którzy chcą tworzyć aplikacje mogące korzystać z interfejsu API JSON dla Bloggera.

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

Ta wersja interfejsu API JSON dla Bloggera jest obecnie dostępna tylko do odczytu. Planujemy dodać inne funkcje odczytu i zapisu. Możesz poprosić o inne funkcje na Forum pomocy Bloggera.

Zanim rozpoczniesz

Załóż konto Google

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

Zapoznaj się z Bloggerem

Jeśli nie znasz się na pojęciach z Bloggera, przeczytaj ten dokument i poeksperymentuj z interfejsem. W tym dokumencie założono, że znasz się na Bloggerze oraz masz pojęcia o programowaniu stron i formatach danych.

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

Gdy aplikacja żąda prywatnych danych, prośba musi zostać autoryzowana przez uwierzytelnionego użytkownika, który ma do nich dostęp.

Gdy aplikacja żąda danych publicznych, żądanie nie musi być autoryzowane, ale musi mu towarzyszyć identyfikator, np. klucz interfejsu API.

Więcej informacji o autoryzowaniu żądań i używaniu kluczy interfejsu API znajdziesz w artykule Autoryzowanie żądań i identyfikowanie aplikacji w dokumencie Korzystanie z interfejsu API.

Tło interfejsu API JSON dla Bloggera

Pojęcia w Bloggerze

Blogger opiera się na 5 podstawowych pojęciach:

Blogi: główna koncepcja interfejsu API. Na blogu są posty i strony. Ten kontener służy do stosowania w metadanych informacji takich jak Nazwa bloga i Opis.
Posty: post na blogu to element opublikowany przez autora. Zawarte tu informacje powinny być na bieżąco, aby odzwierciedlać tematy, które autorzy chcą teraz opublikować na całym świecie. Zdajemy sobie sprawę, że z czasem posty na blogu stają się coraz starsze i stają się mniej istotne.
Komentarze: miejsce, w którym inne osoby niż autor posta na blogu reagują na jego treści. Wszystko od klocków po bukiety.
Strony: strona jest miejscem do przechowywania treści statycznych, np. biograficznych lub kontaktowania się z użytkownikiem. Są to informacje ponadczasowe, które zmieniają się bardzo często.
Użytkownicy: to osoba, która korzysta z Bloggera, działa jako autor, administrator lub tylko czytelnik. Na blogach publicznych czytelnicy mogą być anonimowi, ale na blogach prywatnych czytelnik musi być zidentyfikowany przez Bloggera.

Blogger API – model danych JSON

Zasób to pojedynczy element danych z unikalnym identyfikatorem. Interfejs API JSON Bloggera działa w 5 typach zasobów:

Blogi – zasób: reprezentuje bloga.
Zasób postów: reprezentuje post; każdy zasób postów jest elementem podrzędnym zasobu bloga.
Zasób komentarzy: reprezentuje komentarz do konkretnego posta. Każdy zasób komentarzy jest elementem podrzędnym zasobu postów.
Zasób stron: reprezentuje stronę statyczną, a każdy zasób utworzony w zasobie podrzędnym.
Zasób dla użytkowników: reprezentuje użytkownika nieanonimowego. Pozwala on zidentyfikować autora strony, posta lub komentarza.

Zasoby bloga obejmują dwa typy zasobów podrzędnych: strony i posty.
Zasób postów może zawierać zasoby podrzędne komentarzy. — Omówienie relacji między zasobami

Model danych interfejsu API JSON Bloggera jest oparty na grupach zasobów zwanych kolekcjami:

Kolekcja blogów: Kolumna &lt="apicollection">Zbiory blogów obejmuje wszystkie blogi, do których użytkownik ma prawa. Możesz wyświetlić listę blogów według użytkowników lub pobrać pojedynczego bloga według identyfikatora.</span="apicollection">
Kolekcja postów: Kolekcja postów obejmuje wszystkie zasoby postów w ramach konkretnego zasobu na bloga.
Zbieranie komentarzy: Zbiór komentarzy składa się ze wszystkich zasobów komentarzy w ramach konkretnego zasobu postów.
Kolekcja stron: Kolekcja stron składa się ze wszystkich zasobów stron w ramach konkretnego zasobu blogów.
Kolekcja użytkowników: Kolekcja użytkowników składa się ze wszystkich zasobów użytkowników w Bloggerze, więc nie można jej wymienić. Użytkownik może pobrać swój zasób użytkownika (ale nikt inny) za pomocą identyfikatora lub identyfikatora self.

Operacje interfejsu API JSON dla Bloggera

W interfejsie API JSON Bloggera można wywoływać 2 różne metody opisane w tabeli poniżej.

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

Poniższa tabela pokazuje, które metody są obsługiwane przez poszczególne typy zasobów. Wszystkie operacje na liście i get w blogach prywatnych wymagają uwierzytelniania.

Typ zasobu	Obsługiwane metody
	list	Pobierz
Blogi	tak	tak
Wpisy	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ą protokołu REST bezpośrednio lub z JavaScriptu (nie jest wymagany kod po stronie serwera).
Korzystanie z bibliotek klienta.

REST

REST to architektura oprogramowania zapewniająca wygodne i spójne podejście do żądania oraz modyfikowania danych.

Termin REST to skrót od " State State Transfer. W kontekście interfejsów API Google oznacza to użycie czasowników HTTP do pobierania i modyfikowania danych przechowywanych przez Google.

W systemie REST zasoby są przechowywane w magazynie danych. Klient wysyła żądanie wykonania określonego działania (na przykład utworzenia, pobrania, zaktualizowania lub usunięcia zasobu), a serwer wykonuje działanie i wysyła odpowiedź, często w postaci 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 zasób przez unikalny globalnie identyfikator URI tego formularza:

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

Wszystkie zasoby API mają unikalne identyfikatory URI dostępne przy użyciu HTTP, dlatego funkcja REST umożliwia zapisywanie danych w pamięci podręcznej i jest zoptymalizowana pod kątem współpracy z rozproszoną infrastrukturą sieciową.

Definicje metod znajdziesz w dokumentacji standardu HTTP 1.1. Zawierają one specyfikacje GET, POST, PUT i DELETE.

REST w interfejsie API JSON dla Bloggera

Obsługiwane operacje Bloggera są mapowane bezpośrednio na czasowniki HTTP REST zgodnie z opisem w operacjach Bloggera dotyczących interfejsu API JSON.

Identyfikator URI identyfikatorów URI JSON w interfejsie API Bloggera to:

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 omówienie identyfikatorów URI oraz wyniki każdej obsługiwanej operacji w interfejsie API znajdziesz w dokumentacji interfejsu API JSON dla Bloggera.

Oto kilka przykładów, jak to działa w interfejsie API JSON Bloggera.

Lista blogów, do których uwierzytelniony użytkownik ma uprawnienia:

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

Pobierz posty na bloga code.blogger.com (identyfikator bloga: 3213900):

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

REST z JavaScriptu

Wywołanie interfejsu API JSON Bloggera możesz wywołać z poziomu REST w języku JavaScript, używając parametru zapytania callback i funkcji wywołania zwrotnego. Pozwala to tworzyć rozbudowane aplikacje, które wyświetlają dane z Bloggera bez konieczności pisania kodu po stronie serwera.

Ten przykład pobiera posta z bloga code.blogger.com (po zastąpieniu YOUR-API-KEY swoim 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, niezależny od języka format danych, który reprezentuje prosty tekst reprezentujący dowolne struktury danych. Więcej informacji znajdziesz na stronie json.org.