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

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

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

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

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

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

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

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

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

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

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

История API Blogger

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

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

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

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

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

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

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

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

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

Коллекция постов

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

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

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

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

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

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

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

Операции API Blogger

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

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

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

REST в Blogger API

Поддерживаемые операции Blogger напрямую сопоставляются с HTTP-командами REST, как описано в разделе Операции 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

Вы можете вызвать Blogger API из 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 .