Внимание! Запущено тестирование FoxTools API v2.0!
Если у вас возникнут каки-либо вопросы по работе с API, вы можете оставлять их на форуме группы FoxTools.ru.QR
Метод позволяет создавать и читать QR-коды.QR-код (англ. QR - Quick Response, переводится как, быстрый отклик) — это двухмерный штрихкод (бар-код), предоставляющий информацию для быстрого её распознавания с помощью камеры на мобильном телефоне. Технология получила широкое распространение в Японии и сейчас постепенно захватывает весь мир.
С помощью QR-кода можно закодировать абсолютно любую информацию, например: текст, номер телефона или ссылку на сайт. При помощи фотокамеры и специального программного обеспечения, этот код можно легко расшифровать.
Более подробную информацию о QR-кодах читайте в статье «Матричные обозначения в быту».
Параметры
| Имя параметра | Тип | Обязательный | Описание |
|---|---|---|---|
| ACTION | Строка | Да | Действие, которое необходимо выполнить. Возможные значения: ENCODE - создать QR-кол; DECODE - прочитать QR-код. |
| TEXT | Строка | Да, если ACTION=ENCODE | Текст, из которого нужно сделать QR-код. |
| FCOLOR | Строка | Нет | Шестизначный код цвета QR-кода. Используется только если ACTION = ENCODE. Значение по умолчанию: 000000 (черный). |
| BCOLOR | Строка | Нет | Шестизначный код цвета фона QR-кода. Используется только если ACTION = ENCODE. Значение по умолчанию: FFFFFF (белый). |
| SIZE | Целое число | Нет | Размер QR-кода. Используется только если ACTION = ENCODE. Возможны значения от 1 до 10. Значение по умолчанию: 4. |
| FILE1 | Файл | Да, если ACTION=DECODE и не указан URL | Файл, содержащий QR-код, который нужно прочитать. Используется только если ACTION = DECODE. Данный параметр является обязательным, если не указан параметр URL. Допускаются только файлы в форматах: .jpg, .jpeg, .gif, .png и .bmp. |
| URL | Строка | Да, если ACTION=DECODE и не указан FILE1 | Адрес файла, содержащего QR-код, который нужно прочитать. Используется только если ACTION = DECODE. Данный параметр является обязательным, если не указан параметр FILE1. |
| CP | Строка | Нет | Строковое имя или числовой код кодовой страницы (кодировки). Например: windows-1251 или 1251 - кириллица Windows. Значение по умолчанию: UTF-8. Полный список поддерживаемых кодовых страниц можно получить при помощи метода Encodings. |
Примечания
При создании (ENCODE) QR-кода, метод вернет ссылку на графический файл с QR-кодом. Срок действия ссылки не ограничен.Общие сведения
Все команды к API необходимо делать методом POST, на этот же адрес, на котором вы находитесь в данный момент (исключая корневой арес сайта). Тип содержимого (Content-Type) при запросах к API должен быть multipart/form-data.Для доступа к API обязательно нужно передовать идентификатор и открытый ключ доступа, которые можно получить в личном кабинете на сайте http://foxtools.ru в свойствах подключенного к сервису сайта.
Параметры для доступа к API
| Имя параметра | Тип | Обязательный | Описание |
|---|---|---|---|
| ID | Целое число | Да | Уникальный идентификатор сайта в системе. |
| KEY | Guid | Да | Открытый ключ доступа к API. |
| CID | Целое число | Нет | Пользовательский идентификатор. Данный параметр можно передавать, чтобы получать более детальную статистику использования сервера. Например, в этот параметр можно передавать идентификатор пользователя в вашей БД, чтобы знать, сколько раз пользователь использовал тот или иной сервис. |
| CGRP | Целое число | Нет | Группа для пользовательских идентификаторов (CID). Вы можете использовать этот параметр для группировки статистических данных. Например, если в CID вы передаете идентификатор пользователя в вашей БД, то параметр CGRP может быть равен 1. Если в CID вы передаете идентификатор страницы на вашем сайте, то CGRP может быть равен 2. Таким образом, вы сможете выделять статистику для пользователей (CGRP = 1) и страниц (CGRP = 2). |
Примечание. Регистр символов значения не имеет. Это касается любых параметров, как имен, так и значений.
Формат ответа
Выдача результата в API возможна в трех форматах: XML (по умолчанию), JSON, текстовой.Для указания формата выдачи необходимо добавить к адресу страницы запроса имя желаемого формата, через слеш.
Например:
http://api.foxtools.ru/v1/QR/xml
http://api.foxtools.ru/v1/QR/json
http://api.foxtools.ru/v1/QR/text
Дополнительная информация
| Состояние: | Работает |
|---|---|
| Использование: | Бесплатно |
| Всего запросов: | 242189 |
| Запросов сегодня: | 0 |
| Первый запрос: | 24.09.2012 19:04:37 |
| Последний запрос: | 31.05.2016 15:49:20 |