Interfejs API Bloggera: pierwsze kroki

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

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 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. To jest kontener na metainformacje o blogu, takie jak nazwa 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.

Model danych interfejsu API Bloggera

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

  • Zasób z blogów: 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 podrzędny jest elementem podrzędnym zasobu bloga.
  • Zasób dla użytkowników: reprezentuje użytkownika nieanonimowego. Pozwalają one zidentyfikować autora strony, posta lub komentarza.
Zasoby bloga mają 2 typy zasobów podrzędnych, strony i posty.
          Zasób postów może zawierać podrzędne zasoby komentarzy.
Omówienie relacji między zasobami

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

Kolekcja Blogów
Kolekcja </span> zawiera wszystkie blogi, do których użytkownik ma prawa dostępu. Możesz wyświetlać blogi według użytkowników lub pobrać pojedynczego bloga według identyfikatora.</span="apicollection">
Kolekcja postów
Zbiór postów składa się ze wszystkich zasobów postów w ramach konkretnego zasobu na blogach.
Zbieranie komentarzy
Kolekcja komentarzy składa się ze wszystkich zasobów komentarzy w ramach danego zasobu postów.
Kolekcja stron
Zbiór 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 Bloggera

Wywołania szeregu metod dotyczących kolekcji i zasobów w interfejsie Blogger API można wywoływać w sposób opisany 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.
PobierzByUrl Pobiera zasób, wyszukując go według adresu URL. GET z adresem URL przekazanym jako parametr.
getByPath Pobiera zasób na podstawie ścieżki. GET ze ścieżką przekazana jako parametr.
listByUser (Lista użytkowników) Wyświetla listę zasobów należących do użytkownika. GET w kolekcji należącej do użytkownika.
search Wyszukiwanie zasobów na podstawie parametru zapytania. GET w adresie URL wyszukiwania z przekazanym parametrem.
wstaw Utwórz zasób w kolekcji. POST w identyfikatorze URI kolekcji.
usuń Usuwa zasób. DELETE w identyfikatorze URI zasobu.
poprawka Aktualizowanie zasobu przy użyciu semantyki poprawki. PATCH w identyfikatorze URI zasobu.
aktualizacja Zaktualizuj zasób. PUT 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 getByUrl getByPath, listByUser (Lista użytkowników) wyszukiwanie wstaw usuń poprawka zaktualizuj
Blogi nie tak tak nie tak nie nie nie nie nie
Wpisy tak tak nie tak nie tak tak tak tak tak
Komentarze tak tak nie nie nie nie nie nie nie nie
Strony tak tak nie nie nie nie nie nie nie nie
Użytkownicy nie tak nie nie nie nie nie nie nie nie

Style połączeń

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

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

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

Identyfikator URI identyfikatorów URI interfejsu API Bloggera to:

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

Pełne omówienie identyfikatorów URI oraz wyniki każdej obsługiwanej operacji w interfejsie API znajdziesz w dokumentacji interfejsu API Bloggera.

Przykłady

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

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

Pobierz posty na bloga code.blogger.com o identyfikatorze bloga 3213900:

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

REST z JavaScriptu

Interfejs API Bloggera możesz wywołać z JavaScriptu, korzystając z parametru zapytania callback i przez wywołanie funkcji wywołania zwrotnego. Gdy przeglądarka załaduje skrypt, funkcja wywołania zwrotnego zostanie wykonana, a odpowiedź zostanie przekazana do funkcji wywołania zwrotnego. Ta metoda umożliwia tworzenie rozbudowanych aplikacji, które wyświetlają dane z Bloggera bez konieczności podawania kodu po stronie serwera.

Ten przykładowy kod pobiera posta z bloga code.blogger.com po zastąpieniu YOUR-API-KEY kluczem interfejsu API.

<html>
  <head>
    <title>Blogger 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/v3/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.