Функции для работы с учётной записью

Модуль: account

Создать учётную запись

Создаёт учётную запись клиента. Имя учётной представляет из себя адрес электронной почты клиента, на который необходимо предварительно запросить код подтверждения. После создания учётной записи в течении 24 часов необходимо заключить договор и заполнить анкету с персональными данными.

Функция: create_account

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

https://api.codeblast.ru/account/create_account?confirmation_id=185
                                               &confirmation_code=M94JC
                                               &account_name=demo@mail.ru
                                               &account_password=demopass

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

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

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

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

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

Поле Тип Описание
confirmation_id number id подтверждения
confirmation_code string код подтверждения
account_name string имя учётной записи
account_password string пароль учётной записи

Поля ответа:

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

Коды ошибок:

Код ошибки Расшифровка
REG_CONFIRMATION_ID ошибка ввода id подтверждения
"[0-9]{1,20}"
REG_CONFIRMATION_CODE ошибка ввода кода подтверждения
"[a-zA-Z0-9]{5}"
REG_ACCOUNT_NAME ошибка ввода имени учётной записи
"[a-zа-яёA-ZА-ЯЁ0-9\@\+\-\_\.]{6,64}"
REG_ACCOUNT_PASSWORD ошибка ввода пароля учётной записи
".{6,48}"
CHECK_CONFIRMATION_FAIL ошибка проверки подтверждения учётной записи
ACCOUNT_EXISTS учётная запись уже существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Удалить учётную запись

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

Функция: delete_account

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

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

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

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

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

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

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

Поле Тип Описание
account_name string имя учётной записи
account_password 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 ошибка авторизации
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Изменить учётную запись

Функция позволяет изменить имя учётной записи. Имя учётной представляет из себя адрес электронной почты клиента, на который предварительно необходимо запросить код подтверждения.

Функция: change_account

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

https://api.codeblast.ru/account/change_account?confirmation_id=185
                                               &confirmation_code=M94JC
                                               &account_name=demo@mail.ru
                                               &account_password=demopass
                                               &account_new_name=demo-new-post@mail.ru

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

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

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

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

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

Поле Тип Описание
confirmation_id number id подтверждения
confirmation_code string код подтверждения
account_name string имя учётной записи
account_password string пароль учётной записи
account_new_name string новое имя учётной записи

Поля ответа:

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

Коды ошибок:

Код ошибки Расшифровка
REG_CONFIRMATION_ID ошибка ввода id подтверждения
"[0-9]{1,20}"
REG_CONFIRMATION_CODE ошибка ввода кода подтверждения
"[a-zA-Z0-9]{5}"
REG_ACCOUNT_NAME ошибка ввода имени учётной записи
"[a-zа-яёA-ZА-ЯЁ0-9\@\+\-\_\.]{6,64}"
REG_ACCOUNT_PASSWORD ошибка ввода пароля учётной записи
".{6,48}"
REG_ACCOUNT_NEW_NAME ошибка ввода нового имени учётной записи
"[a-zа-яёA-ZА-ЯЁ0-9\@\+\-\_\.]{6,64}"
CHECK_CONFIRMATION_FAIL ошибка проверки подтверждения учётной записи
AUTHORIZATION_FAIL ошибка авторизации
ACCOUNT_EXISTS учётная запись уже существует
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Показать учётную запись

Функция позволяет получить информацию по учётной записи.

Функция: show_account

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

https://api.codeblast.ru/account/show_account?token_data=data:string

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

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
    <account_id>34</account_id>
    <account_name>demo@mail.ru</account_name>
    <account_confirmed>true</account_confirmed>
    <account_datetime>2014-10-22 18:30:12</account_datetime>
    <error_code>OK</error_code>
    <error_text>ошибок нет</error_text>
</response>

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

{
  "account_id": "34",
  "account_name": "demo@mail.ru",
  "account_confirmed": "true",
  "account_datetime": "2014-10-22 18:30:12",
  "error_code": "OK",
  "error_text": "ошибок нет"
}

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

Поле Тип Описание
token_data string токен

Поля ответа:

Поле Тип Описание
account_id string id учётной записи
account_name string имя учётной записи
account_confirmed boolean учётная запись подтверждёна «true, false»
account_datetime datetime дата и время создания учётной записи
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
AUTHORIZATION_FAIL ошибка авторизации
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Изменить пароль учётной записи

Позволяет изменить пароль учетной записи. Для изменения требуется указать текущий пароль. Если текущий пароль утерян, то можно воспользоваться функцией восстановления пароля.

Функция: change_account_password

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

https://api.codeblast.ru/account/change_account_password?account_name=demo@mail.ru
                                                        &account_password=demopass
                                                        &account_new_password=540394
                                                        &account_new_password_again=540394

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

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

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

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

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

Поле Тип Описание
account_name string имя учётной записи
account_password string пароль учётной записи
account_new_password string новый пароль учётной записи
account_new_password_again string подтверждение нового пароля

Поля ответа:

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

Коды ошибок:

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

Восстановить пароль учётной записи

Высылает новый пароль на электронную почту клиента.

Функция: recovery_account_password

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

https://api.codeblast.ru/account/recovery_account_password?captcha_id=185
                                                          &captcha_text=M94JC
                                                          &account_name=demo@mail.ru

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

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

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

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

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

Поле Тип Описание
captcha_id number id капчи
captcha_text string цифро-буквенный код капчи
account_name string имя учётной записи

Поля ответа:

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

Коды ошибок:

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

Опеределить доступность имени

Позволяет определить доступность указанного имени для создания учётной записи.

Функция: check_account_name_availability

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

https://api.codeblast.ru/account/check_account_name_availability?account_name=demo@mail.ru

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

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

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

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

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

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

Поля ответа:

Поле Тип Описание
account_name_available boolean имя учётной записи доступно для регистрации «true, false»
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

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

Показать настройки учётной записи

Функция позволяет узнать настройки учётной записи.

Функция: show_account_settings

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

https://api.codeblast.ru/account/show_account_settings?token_data=data:string

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

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

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

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

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

Поле Тип Описание
token_data string токен

Поля ответа:

Поле Тип Описание
settings_notify_email boolean отправлять уведомление на почту «true, false»
error_code string код ошибки
error_text string расшифровка

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
AUTHORIZATION_FAIL ошибка авторизации
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет

Изменить настройки учётной записи

Функция изменяет настройки учётной записи.

Функция: change_account_settings

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

https://api.codeblast.ru/account/change_account_settings?token_data=data:string
                                                        &settings_notify_email=true

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

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

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

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

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

Поле Тип Описание
token_data string токен
settings_notify_email boolean отправлять уведомление на почту «true, false»

Поля ответа:

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

Коды ошибок:

Код ошибки Расшифровка
REG_TOKEN_DATA ошибка ввода токена
"[a-z0-9\-]{36}"
REG_SETTINGS_NOTIFY_EMAIL ошибка ввода токена
"(true|false)"
AUTHORIZATION_FAIL ошибка авторизации
MAINTENANCE режим обслуживания
ERROR ошибка системы
OK ошибок нет