Blogger JSON API: начало работы

В этом документе объясняется, как начать работу с Blogger JSON API.

Содержание

  1. Введение
  2. Прежде чем ты начнешь
    1. Получите учетную запись Google
    2. Знакомство с Blogger
    3. Узнайте об авторизации запросов и идентификации вашего приложения
  3. Фон JSON API Blogger
    1. Концепции блоггера
    2. Модель данных Blogger JSON API
    3. Операции Blogger API JSON
  4. Стиль вызова
    1. ОТДЫХАТЬ
  5. Формат данных
    1. JSON

Введение

Этот документ предназначен для разработчиков, которые хотят писать приложения, способные взаимодействовать с Blogger JSON API.

Blogger JSON API расширяет версию 2.0 Blogger Data API . Если вы хотите получать данные из Blogger в формате JSON, а не XML, используйте API Blogger JSON. Если вы хотите получать данные в формате XML, используйте API данных Blogger.

Эта версия Blogger JSON API в настоящее время доступна только для чтения. однако мы планируем добавить возможности чтения/записи, а также другие возможности. Не стесняйтесь запрашивать другие функции на справочном форуме Blogger .

Прежде чем ты начнешь

Получите учетную запись Google

Убедитесь, что у вас настроена учетная запись Google . Мы рекомендуем вам использовать отдельный аккаунт Google для целей разработки и тестирования, чтобы защитить себя от случайной потери данных. Если у вас уже есть тестовая учетная запись, все готово; вы можете посетить пользовательский интерфейс Blogger , чтобы настроить, изменить или просмотреть свои тестовые данные.

Знакомство с Blogger

Если вы не знакомы с концепциями Blogger, прочтите этот документ и поэкспериментируйте с пользовательским интерфейсом, прежде чем приступать к написанию кода. В этом документе предполагается, что вы знакомы с Blogger, концепциями веб-программирования и форматами веб-данных.

Узнайте об авторизации запросов и идентификации вашего приложения

Когда ваше приложение запрашивает личные данные, запрос должен быть авторизован аутентифицированным пользователем, имеющим доступ к этим данным.

Когда ваше приложение запрашивает общедоступные данные, запрос не требует авторизации, но должен сопровождаться идентификатором, например ключом API.

Сведения о том, как авторизовать запросы и использовать ключи API, см. в разделе Авторизация запросов и идентификация вашего приложения в документе Использование API.

Фон JSON API Blogger

Концепции блоггеров

Blogger построен на пяти основных принципах:

  • Блоги : основная концепция API. В блоге есть посты и страницы. Это контейнер для метаинформации блога, такой как название блога и описание.
  • Сообщения : сообщение в блоге — это публикуемый элемент, созданный автором блога. Эта информация должна быть своевременной и отражать то, что авторы хотят опубликовать сейчас. Понятно, что со временем контент постов в блогах стареет и становится менее актуальным.
  • Комментарии . Комментарий — это место, где люди, не являющиеся автором сообщения в блоге, реагируют на написанное автором. Все от кирпичей до букетов.
  • Страницы : страница — это место для статического контента, такого как биографическая информация или способы связи с пользователем. Как правило, это вневременная информация, которая меняется не очень часто.
  • Пользователи . Пользователь — это тот, кто взаимодействует с Blogger, будь то автор, администратор или просто читатель. В общедоступных блогах читатели могут быть анонимными, но в частных блогах Blogger должен идентифицировать читателя.

Модель данных Blogger JSON API

Ресурс — это отдельный объект данных с уникальным идентификатором. API Blogger JSON работает с пятью типами ресурсов:

  • Ресурс блогов : представляет блог.
  • Ресурс сообщений : представляет сообщение; каждый ресурс сообщений является дочерним элементом ресурса блогов.
  • Ресурс комментариев : представляет комментарий к определенному сообщению; каждый ресурс комментариев является дочерним элементом ресурса сообщений.
  • Ресурс страниц : представляет статическую страницу; каждый ресурс страниц является дочерним элементом ресурса блогов.
  • Users Resource : представляет неанонимного пользователя. Это используется для идентификации автора страницы, публикации или комментария.
Ресурс Blogs имеет два дочерних типа ресурсов: Pages и Posts. Ресурс сообщений может иметь дочерние ресурсы ресурсов комментариев.
Обзор взаимосвязей между ресурсами

Модель данных Blogger JSON API основана на группах ресурсов, называемых коллекциями:

Коллекция блогов
А Коллекция блогов состоит из всех блогов, к которым у пользователя есть права доступа. Вы можете составить список блогов по пользователям или получить отдельный блог по идентификатору.
Сбор сообщений
Коллекция сообщений состоит из всех ресурсов сообщений в определенном ресурсе блогов .
Коллекция комментариев
Коллекция комментариев состоит из всех ресурсов комментариев в конкретном ресурсе сообщений .
Коллекция страниц
Коллекция страниц состоит из всех ресурсов страниц в определенном ресурсе блогов .
Коллекция пользователей
Коллекция пользователей состоит из всех ресурсов пользователей в Blogger и поэтому не может быть указана. Пользователь может получить свой собственный ресурс Users (но ничей другой) по идентификатору или с помощью идентификатора self .

Операции Blogger API JSON

Вы можете вызывать два разных метода для коллекций и ресурсов в Blogger JSON API, как описано в следующей таблице.

Операция Описание HTTP-сопоставления REST
список Список всех ресурсов в коллекции. GET для коллекции URI.
получить Получает определенный ресурс. GET для URI ресурса.

В таблице ниже показано, какие методы поддерживаются каждым типом ресурсов. Все операции list и get в частных блогах требуют аутентификации .

Тип ресурса
Поддерживаемые методы
список получить
Блоги да да
Сообщения да да
Комментарии да да
Страницы да да
Пользователи нет да

Стили вызова

Существует несколько способов вызова API:

ОТДЫХАТЬ

REST — это стиль архитектуры программного обеспечения, обеспечивающий удобный и последовательный подход к запросу и изменению данных.

Термин REST является сокращением от « Передача репрезентативного состояния ». В контексте API Google это относится к использованию глаголов HTTP для извлечения и изменения представлений данных, хранящихся в Google.

В системе RESTful ресурсы хранятся в хранилище данных; клиент отправляет запрос серверу на выполнение определенного действия (например, создание, извлечение, обновление или удаление ресурса), а сервер выполняет действие и отправляет ответ, часто в форме представления указанного ресурса.

В RESTful API Google клиент указывает действие с помощью команды HTTP, такой как POST , GET , PUT или DELETE . Он определяет ресурс с помощью глобально уникального URI следующего вида:

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

Поскольку все ресурсы API имеют уникальные доступные по HTTP URI, REST обеспечивает кэширование данных и оптимизирован для работы с распределенной сетевой инфраструктурой.

Вы можете найти полезными определения методов в документации по стандартам HTTP 1.1; они включают спецификации для GET , POST , PUT и DELETE .

REST в Blogger JSON API

Поддерживаемые операции Blogger напрямую сопоставляются с HTTP-командами REST, как описано в разделе Операции API Blogger JSON .

Конкретный формат для URI Blogger JSON API:

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

Полное объяснение используемых URI и результаты для каждой поддерживаемой операции в API приведены в документе Blogger JSON API Reference .

Вот несколько примеров того, как это работает в Blogger JSON API.

Перечислите блоги, к которым у аутентифицированного пользователя есть права доступа:

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

Получите сообщения в блоге code.blogger.com (который имеет идентификатор блога 3213900):

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

ОТДЫХ из JavaScript

Вы можете вызвать Blogger JSON API с помощью REST из JavaScript, используя параметр запроса callback и функцию обратного вызова. Это позволяет создавать многофункциональные приложения, отображающие данные Blogger, без написания кода на стороне сервера.

В следующем примере извлекается сообщение из блога code.blogger.com (после замены YOUR-API-KEY вашим ключом 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>

Формат данных

JSON

JSON (нотация объектов JavaScript) — это распространенный независимый от языка формат данных, обеспечивающий простое текстовое представление произвольных структур данных. Для получения дополнительной информации см. json.org .