API

Подключение

Воспользоваться API SQUAD TOOLS можно только после регистрации аккаунта и добавления клана на сервисе.
Чтобы получать данные о клане и его участниках, необходимо получить токен.
Авторизуйтесь, затем, перейдите в «Мои кланы» → Выберите клан в списке доступных → Перейдите в раздел «API».
Если API ранее не было подключено, нажмите на кнопку «Получить токен». Через несколько секунд на экране появится токен. Не публикуйте его и не передавайте посторонним — с помощью токена возможно получить информацию о вашем клане и его участниках.

Получение данных

Запрос к API SQUAD TOOLS выглядит следующим образом: Для запроса понадобятся некоторые параметры из таблицы ниже. Для каждого параметра есть своё назначение, благодаря которым можно получить необходимый набор данных.
Структура запроса
Параметр Использование Описание
tokenобязательнотокен клана, для которого будет выведена информация
requestобязательновид запрашиваемых данных:
user
,
users
или
clans
queryнеобязательнопараметры к виду запрашиваемых данных, позволяющие уточнить поиск
Параметры к типу запроса
Параметр Тип данных Описание
idуникальный, intпорядковый номер записи в сервисе
usernameне уникальный, stringимя пользователя, используемое в игре
steamIdуникальный, stringномер аккаунта Steam
Возвращаемые параметры
Параметр Тип данных Возвращаемые значения Описание
resultint0 при успехе
1 при ошибке
результат выполнения запроса, при неуспешном — ознакомьтесь со значением параметра «message»
messagestringкомментарий при неуспешном выполнении запроса
usersarrayuserмассив участников клана
clansarrayclanмассив кланов, зарегистрированных на сервисе
user array id, login, steamLogin, steamHours, steamId, status, rankName, rankId, invited_at данные об участнике клана
clanarrayid, tag, nameданные о клане
user.idintуникальныйпорядковый номер записи в сервисе
user.loginintуникальныйлогин аккаунта в сервисе
user.steamLoginstringнеуникальныйимя аккаунта Steam
user.steamHoursintминутычасов в игре (0 — закрытый профиль)
user.steamIdintуникальныйномер аккаунта Steam (SteamID)
user.statusint0 — Забанен
1 — Бывший участник
2 — Участник
3 — Владелец
статус участника в клане
user.rankNamestringнеуникальныйназвание ранга, присвоенный пользователю
user.rankIdintнеуникальныйномер ранга в сервисе. используйте таблицу рангов, чтобы связать их при интеграции корректно
user.invited_attimestampYYYY-MM-DD HH:MM:SSдата добавления в клан
clans.idintуникальныйпорядковый номер клана в сервисе
clans.tagstringнеуникальныйтег, по умолчанию используемый кланом
clans.namestringнеуникальныйназвание клана
clans.sametagsarrayмассив, содержащий данные формата clans.tagмассив с тегами, которые клан может использовать

Примеры использования

Запрос для получения списка участников клана: Ответ: Запрос для получения участника клана по steamId: Ответ:

Ограничения

API SQUAD TOOLS отслеживает адекватность количества отправляемых запросов и может ограничить доступ к API на некоторое время.
Запрос В секунду В минуту В час
users16
clans16
user53001800