API QR-кода. Что это такое и как его использовать? Подробная инструкция

Чтобы создать QR код для ссылки, видео или картинки - кликните на кнопку ниже.

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

API (Application Programming Interface) - это тип программного интерфейса, который объединяет различные продукты и услуги друг с другом. При этом внутренняя реализация сервиса, встраеваемого в существующую архитектуру посредствам API не важна для разработчика. Это помогает сэкономить время и средства на разработку. В случае с QR-кодами, это выражается в отсутствии необходимости ручного их создания через пользовательский интерфейс генератора, с последующим сохранением и вставкой в необходимый сервис.

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

API (Application Programming Interface) - это тип программного интерфейса, который объединяет различные продукты и услуги друг с другом. При этом внутренняя реализация сервиса, встраеваемого в существующую архитектуру посредствам API не важна для разработчика. Это помогает сэкономить время и средства на разработку. В случае с QR-кодами, это выражается в отсутствии необходимости ручного их создания через пользовательский интерфейс генератора, с последующим сохранением и вставкой в необходимый сервис.

Как использовать API генератора QR-кодов?

Чтобы использовать API для создания QR-кода ME-QR, следуйте следующим 4 шагам:

Как использовать API генератора QR-кодов?

Чтобы использовать API для создания QR-кода ME-QR, следуйте следующим 4 шагам:

1. Получите токен допуска

Токен допуска - это удостоверение, которое информирует API о том, что пользователь токена уполномочен получать допуск к функционалу отвечающего сервиса. Чтоб получить токен, зайдите на сайт генератора ME-QR под своим логином в раздел “Персональные данные”.

1. Получите токен допуска

Токен допуска - это удостоверение, которое информирует API о том, что пользователь токена уполномочен получать допуск к функционалу отвечающего сервиса. Чтоб получить токен, зайдите на сайт генератора ME-QR под своим логином в раздел “Персональные данные”.

2. Ознакомьтесь с документацией

API можно считать "контрактом" с документацией между двумя сторонами. Он подразумевает определенную программную реакцию одной стороны на получение удаленного, структурированного согласно документации, запроса от первой. Документацию по API ME-QR можно найти по следующему адресу.

2. Ознакомьтесь с документацией

API можно считать "контрактом" с документацией между двумя сторонами. Он подразумевает определенную программную реакцию одной стороны на получение удаленного, структурированного согласно документации, запроса от первой. Документацию по API ME-QR можно найти по следующему адресу.

3. Сформулируйте запрос

Запрос содержит ряд обязательных для заполнения атрибутов:

"token" - токен доступа, получаемый согласно Пункту 1 данного руководства. Имеет строчный тип данных и берется в скобки.
"qrType" - тип QR-кода. Представляет из себя целочисленное значение, обозначающее конкретный тип согласно списку предлагаемых. Список можно посмотреть на вкладке "Schema" страницы документации.
"title" - название кода для удобного его поиска среди созданных вами, в разделе "QR-коды" вашей учетной записи. Имеет строчный тип данных и берется в скобки.
"service" - сервис запроса. В данном случае следует выбирать "api". Имеет строчный тип данных и берется в скобки.
"format" - формат создаваемого QR-кода. К выбору доступны форматы: "png", "jpeg", "svg", "json". Имеет строчный тип данных и берется в скобки.
"qrOptions" - атрибут, определяющий внешний вид создаваемого QR-кода. Содержит в себе ряд свойств (размер, цвет, форму элементов, логотип и т.д.). С полным списком свойств и их значениями можно ознакомиться на вкладке "Schema" страницы документации.
"qrFieldsData" - атрибут, определяющий содержание создаваемого QR-кода. Содержит в себе ряд свойств уникальных для каждого выбранного типа кода. С полным списком свойств и их значениями для каждого типа можно ознакомиться в списке "Schemas" страницы документации.

3. Сформулируйте запрос

Запрос содержит ряд обязательных для заполнения атрибутов:

"token" - токен доступа, получаемый согласно Пункту 1 данного руководства. Имеет строчный тип данных и берется в скобки.
"qrType" - тип QR-кода. Представляет из себя целочисленное значение, обозначающее конкретный тип согласно списку предлагаемых. Список можно посмотреть на вкладке "Schema" страницы документации.
"title" - название кода для удобного его поиска среди созданных вами, в разделе "QR-коды" вашей учетной записи. Имеет строчный тип данных и берется в скобки.
"service" - сервис запроса. В данном случае следует выбирать "api". Имеет строчный тип данных и берется в скобки.
"format" - формат создаваемого QR-кода. К выбору доступны форматы: "png", "jpeg", "svg", "json". Имеет строчный тип данных и берется в скобки.
"qrOptions" - атрибут, определяющий внешний вид создаваемого QR-кода. Содержит в себе ряд свойств (размер, цвет, форму элементов, логотип и т.д.). С полным списком свойств и их значениями можно ознакомиться на вкладке "Schema" страницы документации.
"qrFieldsData" - атрибут, определяющий содержание создаваемого QR-кода. Содержит в себе ряд свойств уникальных для каждого выбранного типа кода. С полным списком свойств и их значениями для каждого типа можно ознакомиться в списке "Schemas" страницы документации.

4. Примените ваш запрос

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

4. Примените ваш запрос

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

Ещё одно преимущество работы с нашим API

В результате работы с нашим API, вы получаете полноценные динамические QR-коды, каждый из которых отображается в вашем аккаунте. Это означает, что вы можете впоследствии изменять их содержимое, не меняя внешнего вида. Кроме этого, доступна аналитика каждого отдельного QR-кода. Эти функции доступны в разделе "QR Codes" вашей учетной записи.

Обратите внимание, что использование API ME-QR доступно исключительно для тарифов Premium. Ознакомиться с ними (как и с другими тарифами и полным списком преимуществ каждого) вы можете по ссылке. Выбирайте тот, который наиболее подходит вашим нуждам и начинайте создавать коды с API нашего бесплатного генератора QR-кодов уже сегодня!