Категория:API — различия между версиями

Материал из Игры ClanWars - браузерная игра из серии игр: Бойцовский клуб, Комбатс, Олд БК
 
(не показано 7 промежуточных версии этого же участника)
Строка 4: Строка 4:
 
Взаимодействие между сервером Clan Wars происходит по HTTP-протоколу.
 
Взаимодействие между сервером Clan Wars происходит по HTTP-протоколу.
  
 +
API выдаёт информацию в json формате, кодировка UTF-8.
  
 
Для получения информации необходимо послать POST/GET-запрос по адресу:  
 
Для получения информации необходимо послать POST/GET-запрос по адресу:  
Строка 16: Строка 17:
 
Параметры запроса:
 
Параметры запроса:
  
[http://cwars.ru/public_api.php?info=user&login]<nowiki>={user_login}, где</nowiki>
+
[http://cwars.ru/public_api.php?info=user&login http://cwars.ru/public_api.php?info=user&login]<nowiki>={user_login}, где</nowiki>
  
 
{user_login} — логин пользователя
 
{user_login} — логин пользователя
Строка 23: Строка 24:
 
2. Информация о клане.
 
2. Информация о клане.
  
[http://cwars.ru/public_api.php?info=user&login http://cwars.][http://cwars.ru/public_api.php?info=user&login ru][http://cwars.ru/public_api.php?info=user&login /public_api.php?][http://cwars.ru/public_api.php?info=user&login info=clan&]name={clan_name}, где
+
[http://cwars.ru/public_api.php?info=clan& http://cwars.ru/public_api.php?info=clan&]name={clan_name}, где
  
 
{clan_name} — название клана
 
{clan_name} — название клана
Строка 40: Строка 41:
  
 
* login [''string'']
 
* login [''string'']
 +
* sex [''string''] - имеет два варианта обозначения: m - мужской пол; f - женский пол
 
* params [''array'']
 
* params [''array'']
* level [''integer'']
+
** level [''integer'']
* strength [''integer'']
+
** strength [''integer'']
* agility [''integer'']
+
** agility [''integer'']
* intuition [''integer'']
+
** intuition [''integer'']
* life [''integer'']
+
** life [''integer'']
 
* statistic [''array'']
 
* statistic [''array'']
* win [''integer'']
+
** win [''integer'']
* lose [''integer'']
+
** lose [''integer'']
* draw [''integer'']
+
** draw [''integer'']
 
* status [''array'']
 
* status [''array'']
* сlan_name [''string'']
+
** сlan_name [''string'']
* clan_status_name [''string'']
+
** clan_status_name [''string'']
* town [''string'']
+
** town [''string'']
* reg_date [''string'']
+
** reg_date [''string'']
* marriage [''array'']
+
** marriage [''array'']
* partner [''string'']
+
*** partner [''string'']
* blank [''string'']
+
*** blank [''string'']
 
* skills [''arrays'']
 
* skills [''arrays'']
* master [''integer'']
+
** master [''integer'']
* name [''string'']
+
** name [''string'']
  
 
2. Информация о клане:
 
2. Информация о клане:
Строка 70: Строка 72:
 
* castle_level [''integer'']
 
* castle_level [''integer'']
 
* members [''arrays'']
 
* members [''arrays'']
* clan_status_name [''string'']
+
** clan_status_name [''string'']
* login [''string'']
+
** login [''string'']
 +
** level [integer]
 +
** sex [string] - имеет два варианта обозначения: m - мужской пол; f - женский пол
  
 
Коды ошибок:
 
Коды ошибок:

Текущая версия на 08:47, 29 сентября 2014

Clan Wars API


Взаимодействие между сервером Clan Wars происходит по HTTP-протоколу.

API выдаёт информацию в json формате, кодировка UTF-8.

Для получения информации необходимо послать POST/GET-запрос по адресу:

http://cwars.ru/public_api.php


Получения информации:

1. Информация об игроке.

Параметры запроса:

http://cwars.ru/public_api.php?info=user&login={user_login}, где

{user_login} — логин пользователя


2. Информация о клане.

http://cwars.ru/public_api.php?info=clan&name={clan_name}, где

{clan_name} — название клана


В ответ данные возвращаются в json формате. Массив имеет такие параметры:

  • "ok" — (bool) результат ответа: успех или неудача
  • "error_code" — (integer) код ошибки, при неудаче
  • "data" — (array) информация по запросу.

Данные, которые возвращаются в результате запроса:


1. Информация об игроке:

  • login [string]
  • sex [string] - имеет два варианта обозначения: m - мужской пол; f - женский пол
  • params [array]
    • level [integer]
    • strength [integer]
    • agility [integer]
    • intuition [integer]
    • life [integer]
  • statistic [array]
    • win [integer]
    • lose [integer]
    • draw [integer]
  • status [array]
    • сlan_name [string]
    • clan_status_name [string]
    • town [string]
    • reg_date [string]
    • marriage [array]
      • partner [string]
      • blank [string]
  • skills [arrays]
    • master [integer]
    • name [string]

2. Информация о клане:

  • name [string]
  • birth [string]
  • level [integer]
  • site [string]
  • castle_level [integer]
  • members [arrays]
    • clan_status_name [string]
    • login [string]
    • level [integer]
    • sex [string] - имеет два варианта обозначения: m - мужской пол; f - женский пол

Коды ошибок:


Код ошибки
Описание
Фатальность*
0
Успех
-
104
Неверно задан параметр info
+
128
Неверно задан параметр login
+
147
Неверно задан параметр name
+
150
Сервер занят, повторите запрос позже
-

* фатальность – при повторном запросе результат не изменится (ошибка не временная)

Эта категория в данный момент пуста.

Персональные инструменты

Пространства имён