STQR API
Общая информация

STQR API - это программный интерфейс, разработанный STQR.ru, для генерирования статических и динамических QR-кодов.

Что можно делать с помощью STQR API :
  • создавать статические и динамические QR-коды;
  • удалять созданные ранее статические и динамические QR-коды из личного кабинета;
  • получать информацию о количестве созданных QR-кодов в удобном для обработки формате;
  • редактировать отдельные поля динамических QR-кодов;
  • и многое другое

Доступ к STQR API предоставляется на платной основе с активированным тарифом Безлимитный. Стоимость не зависит от числа генерируемых QR-кодов, подключаемых приложений, но зависит от количества вызовов API, т.е. от интенсивности обмена данными между вашим приложением и нашими серверами STQR.ru.

Доступ к методам API возможен только при наличии специализированного token-ключа. Token-ключ автоматически создается при активации соответствующего тарифного плана и в дальнейшем может быть изменен по запросу. Посмотреть token-ключ можно в разделе Профиль -> AP

Если вам требуется доподнительная техническая поддержка - перейдите в раздел техническая поддержка и оставьте задайте там свой вопрос.

Формат запроса

Запросы осуществляются посредством протокола HTTP 1.1 на адрес: http://stqr.ru/api/<версия API>/<имя_метода>

где: <версия API> - необходимая версия API. Актуальная версия : 0.8
<имя_метода> - имя метода из списка доступных test, create, read, update, delete, list

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

Для передачи параметров запроса используется следующий формат:

  • каждый параметр указывается парой ключ/значение в виде параметра POST-запроса
  • MIME-тип: application/x-www-form-urlencoded
  • кодировка символов: UTF-8

Пример запроса:

POST /api/0.8/create HTTP/1.1
Host: stqr.ru
Content-Type: application/x-www-form-urlencoded

token=&param1=value1&param2=value2&param3=value3

Формат ответа

Ответ сервиса представляет собой JSON-документ в кодировке UTF-8. Содержимое документа зависит от выполняемого метода и результата выполнения запроса.

Пример ответа в случае успешного выполнения:

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 51
Expires: Thu, 11 Dec 2016 16:00:00 GMT
Cache-Control: no-cache

{
"param1":"value1",
"param2":"value2"
}
  • запрос невозможно разобрать;
  • в запросе параметр token
  • в запросе указан несуществующий, некорректный или просроченный токен
  • запрошена операция, на которую у токена нет прав.

При отказе в авторизации запроса в ответе присутствуют следующие поля:

Поле Описание
error Код причины отказа в авторизации.
error_description Дополнительное текстовое описание причины отказа.

Коды причины отказа в авторизации:

HTTP-код ответа Значение поля error Описание
400 invalid_request Формат HTTP-запроса не соответствует протоколу. Запрос невозможно разобрать, либо заголовок имеет некорректное значение.
401 invalid_token Указан несуществующий, просроченный, или отозванный токен.
403 insufficient_scope Запрошена операция, на которую у токена нет прав.

Подробная информация STQR API для создания:

cтатических QR-кодов

динамических QR-кодов

динамических STQR-объявлений