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

В этом документе объясняется, как начать использовать API Blogger.

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

Получить аккаунт Google

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

Познакомьтесь с Blogger

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

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

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

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

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

История API Blogger

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

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

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

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

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

• Ресурс блогов : представляет блог.
• Ресурс сообщений : представляет сообщение; каждый ресурс сообщений является дочерним по отношению к ресурсу блогов.
• Ресурс комментариев : представляет комментарий к определенному сообщению; каждый ресурс комментариев является дочерним по отношению к ресурсу сообщений.
• Ресурс страниц : представляет статическую страницу; каждый ресурс страниц является дочерним по отношению к ресурсу блога.
• Ресурс пользователей : представляет неанонимного пользователя. Используется для идентификации автора страницы, публикации или комментария.

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

Коллекция блогов

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

Коллекция сообщений

Коллекция сообщений состоит из всех ресурсов сообщений в пределах определенного ресурса блогов .

Сбор комментариев

Коллекция комментариев состоит из всех ресурсов комментариев в пределах определенного ресурса сообщений .

Коллекция страниц

Коллекция страниц состоит из всех ресурсов страниц в пределах определенного ресурса блогов .

Коллекция пользователей

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

Операции API Blogger

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

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

Стили вызова

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

• Использование REST напрямую или из JavaScript (код на стороне сервера не требуется)
• Использование клиентских библиотек .

ОТДЫХ

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 имеют уникальные URI, доступные по HTTP, REST обеспечивает кэширование данных и оптимизирован для работы с распределенной инфраструктурой Интернета.

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

REST в API Blogger

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

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

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

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

Примеры

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

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

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

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

ОТДЫХ из JavaScript

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

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

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

JSON

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