Руководство по использованию web-сервиса работы с QR-кодами

API данного сервиса предоставляет простой и удобный интерфейс работы с QR-кодами (создание и распознавание) для использования в вашем приложении. Для работы с API необходимо отправить HTTP запрос с необходимыми параметрами по заданному адресу. Сервис предоставляем доступ к двум методам.

1. Распознавание (сканирование) qr-кода в изображении

Метод read-qrcode анализирует отправленное пользователем на сервер изображение, находит qr-код, дешифрует его и вернет результат в виде строки. Метод можно вызвать двумя способами.

1.1. Отправить GET-запрос на URI:


            http://qrcode-service.ru/read-qrcode

и задать GET-параметр file в который передать URI файла. Пример:


            http://qrcode-service.ru/read-qrcode?file=http://qrcode-service.ru/image/qrCodeCloudtips.png

1.2. Отправить POST-запрос на тот же URI. В теле запроса необходимо передать полезную нагрузку в виде

формы (multipart/form-data) с n-м количеством графических файлов;
бинарного вложения одного файла.

От сервера будет получен ответ в формате JSON:

{
    "status": "ok",
    "result": "Текст, закодированный в qr-коде",
}

Если отправлялась форма с несколькими файлами, в свойстве result будет находиться вложенный объект с наименованиями, соответствующими именам ключей формы

{
    "status": "ok",
    "result": {
            "file1": "Текст, закодированный в qr-коде file1",
            "file2": "Текст, закодированный в qr-коде file2",
            "file3": "Текст, закодированный в qr-коде file3",
    }
}

2. Создание (генерация) qr-кода

Метод get-qrcode принимает строку, создает изображение qr-кода в виде строки base64, возвращает в любом из заданных форматов. Метод можно вызвать двумя способами.

2.1. Отправить GET-запрос на URI:


            http://qrcode-service.ru/get-qrcode

Поддерживаться следующие get-параметры

Параметр	Тип	Описание
text	string	Текс котрый необходимо закодировать в qr-код
type_response	string	Определяет формат ответа от сервера. img - вернуться готовый фрагмент html-кода обернутый в тэг img. base64 - вернуться только изображение в виде строки base64. json (значение по умолчанию) - ответ будет в формате json.
class	string	Если используете type_response=img, тогда можно передать имя нужного class для тэга img, для дальнейшего задания стилей css

Простой пример для быстрого создания qr-кода


            http://qrcode-service.ru/read-qrcode?text=еще немного букв&type_response=img

            http://qrcode-service.ru/read-qrcode?text=некоторый текст

2.2. Отправить POST-запрос тот же URI, и в теле запроса передать json

{
    "text": "Текст который необходимо закодировать в qr-коде",
    "type_response": "img",
    "class": "my-qr-code",
}

Описание свойств передаваемого объекта в формате JSON полностью соответствуют параметрах из пункта 2.1. и не требуют отдельного описания.

Примеры ответа сервера в зависимости от выбранного параметра type_response

img:

<img
    src="data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiBjbGFzcz0icX..."
    style="max-width: 500px"
/>

base64:

data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiBjbGF...

json:

{
    "status":"ok",
    "base64":"data:image\/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiPz4NCjxzdmcgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiBjbGFzcz..."
}