Для создания интеграции с SMS-шлюзами пользователь должен иметь роль Администратор или обладать правами SMS_GATEWAY_READ, SMS_SEND_METHOD_AVAILABLE, и System - Create.

Получение токена авторизации API

Для того, чтобы выполнить отправку учетных данных с помощью API, необходимо получить токен авторизации.

Данный токен позволяет выполнять API-запросы и остаётся актуальным до 12 часов при непрерывном использовании. Использование считается непрерывным в случае, если временной интервал между запросами не превышает 15 минут. Если данный интервал превышает 15 минут, необходимо повторить запрос токена авторизации.

Для того, чтобы получить токен авторизации, выполните следующие действия:

Шаг 1. Подключитесь с помощью любой системы автоматизации работы с API (Swagger, Postman и т.д.).

Шаг 2. Выберите тип запроса POST и укажите в поле запроса https://<IP-адрес_AxelNAC>:<Порт_AxelNAC>/api/v1/login.

Шаг 3. В тело запроса добавьте следующую информацию в формате raw:

{
  "password": "Пароль_для_входа_в_AxelNAC",
  "username": "Логин_для_входа_в_AxelNAC"
}

Шаг 4. Выполните запрос.

Если учетные данные были указаны верно, в качестве ответа будет отправлен токен авторизации API следующего вида:

Отправка учетных данных в SMS-сообщении

Для того, чтобы отправить пользователю-гостю SMS-сообщение с учетными данными, выполните следующие действия:

Шаг 1. Подключитесь с помощью любой системы автоматизации работы с API (Swagger, Postman и т.д.).

Шаг 2. Выберите тип запроса POST и укажите в поле запроса https://<IP-адрес_AxelNAC>:<Порт_AxelNAC>/api/v1/sms_gateways/send_user_credentials.

Шаг 3. Выберите тип авторизации Bearer Token и введите токен авторизации.

Шаг 4. В тело запроса добавьте следующую информацию в формате raw:

    {
    "sms_gateway":"Используемый_SMS-шлюз",
    "pid":"Имя_пользователя-гостя_в_AxelNAC",
    "password":"Пароль_для_пользователя-гостя",
    }

Для корректной отправки учетных данных, в профиле пользователя должен быть указан его номер телефона.

Шаг 4. Выполните запрос.

После выполнения запроса пользователю-гостю будут отправлены учетные данные для доступа к сети в SMS-сообщении на номер, который был указан при создании.

Отправка информационных сообщений

Для того, чтобы отправить пользователю SMS-сообщение с какой-либо информацией, выполните следующие действия:

Шаг 1. Подключитесь с помощью любой системы автоматизации работы с API (Swagger, Postman и т.д.).

Шаг 2. Выберите тип запроса POST и укажите в поле запроса https://<IP-адрес_AxelNAC>:<Порт_AxelNAC>/api/v1/sms_gateways/send_sms.

Шаг 3. Выберите тип авторизации Bearer Token и введите токен авторизации.

Шаг 4. В тело запроса добавьте следующую информацию в формате raw:

    {
    "sms_gateway":"Используемый_SMS-шлюз",
    "phone_number":"Номер_телефона_на_который_будет_отправлено_сообщение",
    "message":"Тело_сообщения",
    }

Шаг 4. Выполните запрос.

После выполнения запроса пользователю будет отправлено SMS-сообщение на номер, который был указан при регистрации.