API — различия между версиями
Материал из DS-HOST Wiki
Admin (обсуждение | вклад) (Новая страница: « = Общая информация = Все запросы к API отправляются в указанном виде: http://ds-host.ru/panel/api/?key='''К…») |
Версия 22:13, 7 мая 2017
Содержание |
Общая информация
Все запросы к API отправляются в указанном виде:
http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=МЕТОД
При необходимости, в строку запроса добавляются дополнительные параметры
Пример успешного ответа
Каждый успешный ответ имеет вид:
{"success":true,"responce": ВОЗВРАЩАЕМЫЕ_ДАННЫЕ (Зависят от конкретного запроса) }
Параметр success, будет true если запрос выполнился без ошибок.
Пример ответа с ошибкой
Каждый ответ с ошибкой будет иметь вид:
{"success":false,"error_message":"Описание ошибки"}
Поле success, будет false т.к. запрос был выполнен с ошибкой.
Поле error_message, будет содержать строку с описанием ошибки и будет заполнен, только если были ошибки при выполнении запроса.
Аккаунт пользователя
account.getInfo
Пример запроса:
http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=account.getInfo
При успешном результате в объекте(responce), содержатся следующие поля:
"id": Id пользователя "first_name": Имя пользователя "last_name": Фамилия пользователя "balance": баланс в рублях "ip": Текущий ip адрес пользователя (не считая авторизации через API) "last_ip": Последний ip адрес пользователя (не считая авторизации через API)
Игровые сервера пользователя
servers.get
Пример запроса:
http://ds-host.ru/panel/api/?key=КЛЮЧ_API&action=servers.get
При успешном результате в объекте(responce), содержится массив с игровыми серверами пользователя. Каждый элемент имеет поля:
"id": Id сервера "status": 0 - не установлен; 1 - установлен; 2 - просрочен; 3 - в очереди на установку; 4 - в процессе установки; 5 - не оплачен;