Для работы с API требуется инициализация с помощью приватного ключа и ID аккаунта. Эта информация может быть получена в контрольной панели. Все последующие запросы должны включать токен авторизации access_token.
POST www.evolution.plus/api/access_token
| Параметры инициализации | ||
| Поле | Тип | Описание |
|---|---|---|
| account_id | Число | ID аккаунта |
| secret_code | Строка | Секретный код |
Возвращает массив с токеном авторизации и временем жизни токена (60 минут).
| Результат инициализации | ||
| Поле | Тип | Описание |
|---|---|---|
| access_token | Строка | Токен авторизации |
| timelife | Число | Время жизни токена в секундах |
Возвращает список пользовательских действий в соответствии с заданными параметрами.
POST www.evolution.plus/api/method/action.get
| Параметры действий | ||
| Поле | Тип | Описание |
|---|---|---|
| date1 | UNIXTIME | Начальная дата |
| date2 | UNIXTIME | Конечная дата |
| id | Число | ID действия |
| event_code | Строка | Код типа действия |
| ext_id | Строка | Внешний код действия |
| user_id | Число | ID пользователя |
Возвращает массив действий в соответствии с заданными параметрами.
| Результат | ||
| Поле | Тип | Описание |
|---|---|---|
| id | Число | ID действия |
| ext_id | Строка | Внешний код действия |
| code | Строка | Код типа действия |
| name | Строка | Наименование действия |
| date | Дата/время | Дата и время действия |
| user_id | Число | ID пользователя |
Регистрация действий пользователя в соответствии со списком типов действий, указанным в настройках платформы. Необходимо указать ID пользователя или его хэш-код, а также код типа действия.
POST www.evolution.plus/api/method/action.add
| Параметры | ||
| Поле | Тип | Описание |
|---|---|---|
| user_code | Число | Внешний код пользователя |
| action_code | Строка | Код типа действия |
| time | UNIXTIME | Дата и время действия |
| value | Число | Количественное значение |
| ext_id | Строка | Внешний код действия |
| hash | Строка | Хэш-код пользователя |
Если действие успешно добавлено, система возвращает его ID
| Результат | ||
| Поле | Тип | Описание |
|---|---|---|
| action_id | Число | ID действия |
Удаление действий пользователей выполняется по его внешнему коду
Будут удалены все вознаграждения, связанные с действием.
POST www.evolution.plus/api/method/action.undo
| Параметры | ||
| Поле | Тип | Описание |
|---|---|---|
| ext_id | Строка | Внешний код действия |
Возвращает количество отмененных действий.
| Результат | ||
| Поле | Тип | Описание |
|---|---|---|
| actions | Число | Количество отмененных действий |
Получение пользовательских персональных данных в соответствии с заданными параметрами. Должен быть использован один из параметров.
POST www.evolution.plus/api/method/user.get
| Параметры пользователя | ||
| Поле | Тип | Описание |
|---|---|---|
| ext_id | Строка | Внешний код пользователя |
| id | Число | ID пользователя |
| hash | Строка | Хэш-код пользователя |
| phone | Строка | Телефон пользователя (в любом формате) |
Возвращает массив с персональными данными пользователя
| Результат | ||
| Поле | Тип | Описание |
|---|---|---|
| id | Число | ID пользователя |
| hash | Строка | Хэш-код пользователя |
| phone | Число | Телефон пользователя |
| Строка | Email пользователя | |
| name | Строка | Имя |
| last_name | Строка | Фамилия |
| gender | Строка | Пол |
| ext_id | Строка | Внешний код |
| level_id | Число | ID уровня пользователя |
| referrer_user_id | Число | Рефер |
| admin_description | Текст | Административные записи |
При добавлении нового пользователя обязательно указать его имя.
POST www.evolution.plus/api/method/user.add
| Параметры пользователя | ||
| Поле | Тип | Описание |
|---|---|---|
| ext_id | Число | Внешний код пользователя |
| name | Строка | Имя |
| last_name | Строка | Фамилия |
| photo | Строка | URL фотографии пользователя |
| Строка | Email пользователя | |
| phone | Строка | Телефон пользователя (в любом формате) |
| gender | Строка | Пол (M или F) |
При успешном добавлении пользователя будет возвращен его ID.
| Результат | ||
| Поле | Тип | Описание |
|---|---|---|
| ID | Число | ID пользователя |
Обновление пользовательских данных. Должен быть передан внешний код пользователя или его ID.
POST www.evolution.plus/api/method/user.update
| Параметры пользователя | ||
| Поле | Тип | Описание |
|---|---|---|
| ext_id | Строка | Внешний код пользователя |
| id | Число | ID пользователя |
| name | Строка | Имя |
| last_name | Строка | Фамилия |
| photo | Строка | URL фото пользователя |
| Строка | Email пользователя | |
| phone | Строка | Телефон пользователя (в любом формате) |
| gender | Строка | >Пол (M или F) |
| admin_description | Текст | Административные записи |
| rating | Строка | Публиковать в рейтингах (Y или N) |
Если пользователь успешно отредактирован, будет возвращен его ID
| Результат | ||
| Поле | Тип | Описание |
|---|---|---|
| ID | Число | ID пользователя |
Начисление или списание бонусных баллов пользователя.
POST www.evolution.plus/api/method/money.add
| Параметры транзакции | ||
| Поле | Тип | Описание |
|---|---|---|
| money | Число | Сумма транзакции |
| user_id | Число | ID пользователя |
| description | Строка | Описание транзакции |
Если тразакция успешно добавлена, будет возвращено "OK"
Параметры достижения и прогресс пользователя в достижении
POST www.evolution.plus/api/method/achievement.get
| Параметры достижения | ||
| Поле | Тип | Описание |
|---|---|---|
| user_id | Число | ID пользователя |
| id | Число | ID достижения |
Возвращает массив с параметрами достижения и текущим прогрессом пользователя.
| Результат | ||
| Поле | Тип | Описание |
|---|---|---|
| id | Число | ID достижения |
| name | Строка | Наименование достижения |
| level | Массив | Массив с данными об уровнях достижения |
| money | Массив | Массив с суммой вознаграждения в игровой валюте на каждом уровне достижения |
| level_count | Число | Количество уровней достижения |
| progress_value | Число | Текущий прогресс достижения |
| level_now | Число | Текущий уровень достижения |
| date_unlock | Дата/время | Дата разблокирования достижения |
| progress_percent | Число | Текущий прогресс достижения в процентах |
Отправка СМС сообщения пользователю
POST www.deltacrm.ru/api/method/message.sms
| Параметры SMS | ||
| Поле | Тип | Описание |
|---|---|---|
| user_id | Число | ID пользователя |
| message | Текст | Текст сообщения |
Возвращает ID отправленного сообщения.