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

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

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

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

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

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

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

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

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

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

Для передачи параметров запроса используется Пин Ап формат:

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

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

POST /api8/create HTTP1
Host: stqr.ru
Content-Type: application/x-www-form-urlencoded

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

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

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

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

HTTP1 200 OK
Content-Type: application/json
Content-Length: 51
Пин Ап Thu, 11 Dec 2016 16:00:00 GMT
Cache-Control: no-cache

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

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

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

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

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

Подробная информация STQR API для Пин Ап

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

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

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