Модуль - Number Convert (DEMO)

Модуль для конвертации цифр обычного шрифта в круглые цифры Unicode или эмодзи. Модуль отправляет число в качестве Запроса и возвращает его другим шрифтом.

Пример запроса: 12345
Пример ответа: ➀➁➂➃➄

🗜 Название: «Number Convert (DEMO)»
🔧 Подключение: 🔐Админ | 🗜API Модули | ➕Доб. API Модуль
📑 API документация: https://api.menubuilder.cc/number_convert/docs.

Модуль БЕСПЛАТНЫЙ и создан как ДЕМОНСТРАЦИОННЫЙ - основная задача - помочь освоить БАЗОВЫЕ механики работы с API в конструкторе MenuBuilderBot.

❖ Описание возможностей

Модуль принимает число и возвращает его другим шрифтом. Для конвертации доступно 3 вида шрифтов. Тип шрифта глобально указывается в настройках или в качестве Параметра для отдельных Запросов - смотри ниже.

Так же в ответе бота можно добавить кастомный текст - подпись.

❖ Настройки Модуля

Виды и количество Настроек - индивидуальны для каждого API Модуля.

Code Type

Это Параметр который будет передан в запросе автоматически. Настройка определяет - в какой вид шрифта будет сконвертировано указанное юзером число.

Выбор шрифта для конвертации:
- basic: 1️⃣2️⃣3️⃣ (по умолчанию)
- dark: ❶❷❸
- light: ①②③

Выбранный здесь шрифт устанавливается ГЛОБАЛЬНО для этого Модуля.

Text Suffix

Позволяет указать текст который будет показан ПОСЛЕ сконвертированных цифр. Параметр НЕОБЯЗАТЕЛЬНЫЙ.

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

Например: "Это ДЕМО Модуль!".

❖ Работа с Модулем

Документация по API Модуля: https://api.menubuilder.cc/number_convert/docs.

Ознакомьтесь с тем как выглядит документация по API прежде чем продолжать.

Запросы

Описание доступных Запросов в разделе «Requests». 

Данный модуль выполняет один вид действия - это конвертация чисел. Однако с целью демонстрации возможных вариантов работы с API - ему было добавлено три разных Метода (Endpoints). То есть, ПО СУТИ, это один и тот же Метод - только с разными возможностями и дополнительными Параметрами.

GET requests/convert

Самый базовый Запрос из всех - принимает Число и передаёт его API для обработки.
Нажмите на Запрос в документации чтобы открыть его Параметры.

- Базовый запрос - GET.
- Принимает 3 параметра: «api_key», «bot_id» и «number».
- «api_key», «bot_id» - задаются в самим Модулем автоматически - вам о них заботится не надо.
- Параметр «number» - принимает число от Юзера чтобы передать его API.
- Параметр «number» - является ОБЯЗАТЕЛЬНЫМ.

ОСОБЕННОСТЬ: Отсутствует возможность указывать тип Шрифта для конвертации - будет использована глобальная настройка из Модуля.

Пример URL Запроса:
https://api.menubuilder.cc/number_convert/requests/convert?api_key=aaaaaaaa-bbbbbbbb-cccccccc&bot_id=55555555&number=77
Где:
https://api.menubuilder.cc/number_convert/ - базовый URL
requests/convert - endpiont (метод)
?api_key=aaaaaaaa-bbbbbbbb-cccccccc&bot_id=55555555 - параметры передаваемые модулем автоматически.
&number=77 - число переданное Юзром (Указывается и ассоциируется в Action-е).

В руководстве «Работа с API Модулями» параметр «number» ассоциируется с данными Переменной («num») которую ввёл Юзер в созданной вами Форме.

GET /requests/convert_ext

Более продвинутый Запрос - принимает Число и Код Шрифта, и передаёт их API для обработки.
Нажмите на Запрос в документации чтобы открыть его Параметры.

- Расширенный запрос - GET.
- Принимает 4 параметра: «api_key», «bot_id», «number» и «code_type».
- «api_key», «bot_id» - задаются в самим Модулем автоматически - вам о них заботится не надо.
- Параметр «number» - принимает число от Юзера чтобы передать его API.
- Параметр «number» - является ОБЯЗАТЕЛЬНЫМ.
- Параметр «code_type» - должен содержать "код" типа Шрифта - «basic», «dark», «light» (см. выше раздел настроек «Code Type»).
- Параметр «code_type» - является ОБЯЗАТЕЛЬНЫМ.
- Параметр «code_type» - имеет приоритет над глобальными настройками Модуля.

ОСОБЕННОСТЬ: Присутствует возможность указывать тип Шрифта для конвертации (указание является обязательным Параметром) - глобальная настройка из Модуля будет переопределена.

Пример URL Запроса:
https://api.menubuilder.cc/number_convert/requests/convert_ext?api_key=aaaaaaaa-bbbbbbbb-cccccccc&bot_id=55555555&number=77&code_type=basic
Где:
https://api.menubuilder.cc/number_convert/ - базовый URL
requests/convert - endpiont (метод)
?api_key=aaaaaaaa-bbbbbbbb-cccccccc&bot_id=55555555 - параметры передаваемые модулем автоматически.
&number=77 - Параметр - содержит число переданное Юзром (Указывается и ассоциируется в Action-е).
&code_type=basic - Параметр (являющийся обязательным для этого Метода) содержит код шрифта из документации по API.

GET /requests/convert_opt

Самый универсальный вид Запроса - принимает Число и опционально(!) Код Шрифта, и передаёт их API для обработки.
Нажмите на Запрос в документации чтобы открыть его Параметры.

- Расширенный запрос - GET.
- Принимает 4 параметра: «api_key», «bot_id», «number» и «code_type».
- «api_key», «bot_id» - задаются в самим Модулем автоматически - вам о них заботится не надо.
- Параметр «number» - принимает число от Юзера чтобы передать его API.
- Параметр «number» - является ОБЯЗАТЕЛЬНЫМ.
- Параметр «code_type» - должен содержать "код" типа Шрифта - «basic», «dark», «light» (см. выше раздел настроек «Code Type»).
- Параметр «code_type» - является НЕ ОБЯЗАТЕЛЬНЫМ (если Параметр не указан - будет использована Глобальная настройка из Модуля).
- Параметр «code_type» - (если указан) имеет приоритет над глобальными настройками Модуля.

ОСОБЕННОСТЬ: Присутствует возможность указывать тип Шрифта для конвертации (указание является НЕ обязательным Параметром) - глобальная настройка из Модуля будет переопределена если Параметр указан.

Пример URL Запроса:
https://api.menubuilder.cc/number_convert/requests/convert_opt?api_key=aaaaaaaa-bbbbbbbb-cccccccc&bot_id=55555555&number=77&code_type=basic
Где:
https://api.menubuilder.cc/number_convert/ - базовый URL
requests/convert - endpiont (метод)
?api_key=aaaaaaaa-bbbbbbbb-cccccccc&bot_id=55555555 - параметры передаваемые Модулем автоматически.
&number=77 - Параметр - содержит число переданное Юзром (Указывается и ассоциируется в Action-е).
&code_type=basic - Параметр (являющийся НЕ обязательным для этого Метода) содержит код шрифта из документации по API.

Ответы

Описание формата Ответов (Responses) в разделе «Requests».

 

 

В качестве ответа API вернёт JSON файл с одним Объектом. Нужные ман данные (Сконвертированное Число) находятся в элементе (Property) - «result».

В руководстве «Работа с API Модулями» внутренний макрос «response» ассоциируется со значением параметра «result» из возвращённого JSON файла.