Категория:API — различия между версиями
Editor (обсуждение | вклад) |
Editor (обсуждение | вклад) |
||
(не показано 12 промежуточных версии этого же участника) | |||
Строка 4: | Строка 4: | ||
Взаимодействие между сервером Clan Wars происходит по HTTP-протоколу. | Взаимодействие между сервером Clan Wars происходит по HTTP-протоколу. | ||
+ | API выдаёт информацию в json формате, кодировка UTF-8. | ||
Для получения информации необходимо послать POST/GET-запрос по адресу: | Для получения информации необходимо послать POST/GET-запрос по адресу: | ||
− | [http://cwars.ru/public_api.php | + | [http://cwars.ru/public_api.php http://cwars.ru/public_api.php] |
Строка 16: | Строка 17: | ||
Параметры запроса: | Параметры запроса: | ||
− | [http://cwars.ru/public_api.php?info=user&login | + | [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= | + | [http://cwars.ru/public_api.php?info=clan& http://cwars.ru/public_api.php?info=clan&]name={clan_name}, где |
{clan_name} — название клана | {clan_name} — название клана | ||
Строка 30: | Строка 31: | ||
В ответ данные возвращаются в json формате. Массив имеет такие параметры: | В ответ данные возвращаются в json формате. Массив имеет такие параметры: | ||
− | * "'''ok'''" — (bool) результат ответа: успех или неудача | + | * "'''ok'''" — (''bool'') результат ответа: успех или неудача |
− | * "'''error_code'''" — (integer) код ошибки, при неудаче | + | * "'''error_code'''" — (''integer'') код ошибки, при неудаче |
− | * "'''data'''" — (array) информация по запросу. | + | * "'''data'''" — (''array'') информация по запросу. |
Данные, которые возвращаются в результате запроса: | Данные, которые возвращаются в результате запроса: | ||
Строка 39: | Строка 40: | ||
1. Информация об игроке: | 1. Информация об игроке: | ||
− | * login | + | * login [''string''] |
− | * | + | * sex [''string''] - имеет два варианта обозначения: m - мужской пол; f - женский пол |
− | * | + | * params [''array''] |
− | * strength | + | ** 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''] |
− | * name | + | ** master [''integer''] |
+ | ** name [''string''] | ||
2. Информация о клане: | 2. Информация о клане: | ||
− | * name | + | * name [''string''] |
− | * birth | + | * birth [''string''] |
− | * level | + | * level [''integer''] |
− | * site | + | * site [''string''] |
− | * castle_level | + | * castle_level [''integer''] |
− | * members | + | * members [''arrays''] |
− | * | + | ** clan_status_name [''string''] |
− | * login | + | ** login [''string''] |
+ | ** level [integer] | ||
+ | ** sex [string] - имеет два варианта обозначения: m - мужской пол; f - женский пол | ||
Коды ошибок: | Коды ошибок: |
Текущая версия на 08:47, 29 сентября 2014
Взаимодействие между сервером 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 - женский пол
Коды ошибок:
|
|
|
|
Успех | |
|
Неверно задан параметр info | |
|
Неверно задан параметр login | |
|
Неверно задан параметр name | |
|
Сервер занят, повторите запрос позже | |
* фатальность – при повторном запросе результат не изменится (ошибка не временная)
Эта категория в данный момент пуста.