Функции безопасности и идентификации

Модуль: security

Получить код подтверждения

Высылает на адрес электронной почты код, для подтвеждения учётной записи.

Функция: get_confirmation

Пример GET запроса:

https://api.codeblast.ru/security/get_confirmation?account_name=demo@mail.ru

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <confirmation_id>32</confirmation_id>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "confirmation_id": "32",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
account_name string имя учётной записи

Поля ответа:

Поле Тип Описание
confirmation_id number id подтверждения
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_ACCOUNT_NAME ошибка ввода имени учётной записи
"[a-zа-яёA-ZА-ЯЁ0-9\@\+\-\_\.]{6,64}"
MANY_NUMBER_REQUESTS достигнут лимит запросов
SEND_EMAIL_FAIL ошибка отправки сообщения
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Получить код авторизации

Получение токена по имени учётной записи и паролю (авторизация). Токен является временным уникальным идентификатором, технически он представляет из себя строку, которая выдаётся клиенту при аутентификации. Токен достаточно получить один раз на время сессии. Токен аннулируется если его не применяли в течении 12 часов, а также существует ограничение на 10000 токенов выданных в течении этого времени.

Функция: get_token

Пример GET запроса:

https://api.codeblast.ru/security/get_token?account_name=demo@mail.ru
                                           &account_password=demopass

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <token_data>data:string</token_data>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "token_data": "data:string",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
account_name string имя учётной записи
account_password string пароль учётной записи

Поля ответа:

Поле Тип Описание
token_data string токен
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_ACCOUNT_NAME ошибка ввода имени учётной записи
"[a-zа-яёA-ZА-ЯЁ0-9\@\+\-\_\.]{6,64}"
REG_ACCOUNT_PASSWORD ошибка ввода пароля учётной записи
".{6,48}"
AUTHORIZATION_FAIL ошибка авторизации
ACCEPT_NOT_EXISTS договор не заключён
PERSON_NOT_EXISTS анкеты клиента не существует
MANY_TOKENS достигнут лимит выданных токенов
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Получить код проверки

Получение капчи (код проверки) для создания учетной записи клиента. Графическое изображение имеет формат PNG и передается в виде base64 строки.

Функция: get_captcha

Пример GET запроса:

https://api.codeblast.ru/security/get_captcha

Пример XML ответа:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <captcha_id>32</captcha_id>
    <captcha_image>data:base64</captcha_image>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

Пример JSON ответа:

{
  "captcha_id": "32",
  "captcha_image": "data:base64",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

Поля запроса:

Поле Тип Описание
     

Поля ответа:

Поле Тип Описание
captcha_id number id капчи
captcha_image captcha_image графическое изображение капчи в формате PNG
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет