Документация
Создание запросов

HyperComments API работает по протоколу HTTP и поддерживает сервер-сервер запросы и клиент-сервер запросы.

Для каждого из тарифных планов есть ограничение по количеству запросов в час и ограничение на доступность методов. Подробнее
Построение запросов

Запрос к API состоит из следующих компонентов

  • Версия API
  • Категория API
  • Метод API

Чтобы построить правильный запрос, вам необходимо отформатировать URI следующим образом:

http://c1api.hypercomments.com/{version}/{category}/{method}
Версия API

Для каждого запроса вы должны указать какую версия API вы хотите использовать. В настоящее время активная версия 1.0.

Параметры запроса

Запросы к API можно отправлять методами POST и GET.

Каждый запрос должен состоять из следующих параметров:

Параметр Описание
обязательный
body
JSON строка с параметрами запроса конкретного метода API. Например:
{"widget_id":1,"link":"test.com/page/1","xid":"page_1"}
обязательный
signature
Подпись запроса. Правила формирования подписи.
callback Необязательный параметр, необходимый для кроссдоменных клиент-сервер запросов с использованием технологии JSONP. В значении параметра передается название callback функции в которую будет передан результат выполнения запроса
Формирование подписи запроса

Параметр signature запроса формируется следующим образом:

sha1({BODY} + {SEKRETKEY})

, где

  • sha1 - стандартная хеш-функция SHA-1
  • + - конкатенация текстовой строки
  • {BODY} - значение параметра запроса body
  • {SEKRETKEY} - секретный ключ для конкретного виджета. Вводится администратором или разработчиком виджета в админ разделе сайта: Настройки - Виджет - API
    Для пользователей плагинов Wordpress и Drupal секретный ключ формируется автоматически.
Параметры ответа

Ответ от API приходит в формате JSON (или JSONP если был передан параметр callback).

Каждый успешный ответ содержит поля:

  • result - статус ответа на запрос (success)
  • data - данные ответа на запрос

Каждый неуспешный ответ содержит поля:

  • result - статус ответа на запрос (error)
  • code - код ошибки
  • description - описание ошибки
Авторизация пользователей

Авторизация пользователей происходит через Технологию единого входа SSO (Single Sign-On).

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

Для запросов на API в которых необходимо авторизовать пользователя (comments/create, comments/edit, ...), в параметре запроса BODY в JSON строке необходимо передать поле auth значение, которого является строка авторизации пользователя и включает в себя данные о пользователе, время запроса и подпись. Подробнее о правиле формирования параметра auth.