Подключение
Воспользоваться API SQUAD TOOLS можно только после регистрации аккаунта и добавления клана на сервисе.
Чтобы получать данные о клане и его участниках, необходимо получить токен.
Авторизуйтесь, затем, перейдите в
«Мои кланы» → Выберите клан в списке доступных → Перейдите в раздел «API».
Если API ранее не было подключено, нажмите на кнопку «Получить токен». Через несколько секунд на экране появится токен. Не публикуйте его и не передавайте посторонним — с помощью токена возможно получить информацию о вашем клане и его участниках.
Получение данных
Запрос к API SQUAD TOOLS выглядит следующим образом:
Для запроса понадобятся некоторые параметры из таблицы ниже. Для каждого параметра есть своё назначение, благодаря которым можно получить необходимый набор данных.
| Структура запроса |
| Параметр |
Использование |
Описание |
| token | обязательно | токен клана, для которого будет выведена информация |
| request | обязательно | вид запрашиваемых данных: user , users или clans |
| query | необязательно | параметры к виду запрашиваемых данных, позволяющие уточнить поиск |
| Параметры к типу запроса |
| Параметр |
Тип данных |
Описание |
| id | уникальный, int | порядковый номер записи в сервисе |
| username | не уникальный, string | имя пользователя, используемое в игре |
| steamId | уникальный, string | номер аккаунта Steam |
| Возвращаемые параметры |
| Параметр |
Тип данных |
Возвращаемые значения |
Описание |
| result | int | 0 при успехе1 при ошибке | результат выполнения запроса, при неуспешном — ознакомьтесь со значением параметра «message» |
| message | string | — | комментарий при неуспешном выполнении запроса |
| users | array | user | массив участников клана |
| clans | array | clan | массив кланов, зарегистрированных на сервисе |
| user |
array |
id, login, steamLogin, steamHours, steamId, status, rankName, rankId, invited_at |
данные об участнике клана |
| clan | array | id, tag, name | данные о клане |
| user.id | int | уникальный | порядковый номер записи в сервисе |
| user.login | int | уникальный | логин аккаунта в сервисе |
| user.steamLogin | string | неуникальный | имя аккаунта Steam |
| user.steamHours | int | минуты | часов в игре (0 — закрытый профиль) |
| user.steamId | int | уникальный | номер аккаунта Steam (SteamID) |
| user.status | int | 0 — Забанен1 — Бывший участник2 — Участник3 — Владелец | статус участника в клане |
| user.rank | int | неуникальный | степень ранга (влияет на позицию в списке, больше → выше) |
| user.rankName | string | неуникальный | название ранга, присвоенный пользователю |
| user.rankId | int | неуникальный | номер ранга в сервисе. используйте таблицу рангов, чтобы связать их при интеграции корректно |
| user.invited_at | timestamp | YYYY-MM-DD HH:MM:SS | дата добавления в клан |
| clans.id | int | уникальный | порядковый номер клана в сервисе |
| clans.tag | string | неуникальный | тег, по умолчанию используемый кланом |
| clans.name | string | неуникальный | название клана |
| clans.sametags | array | массив, содержащий данные формата clans.tag | массив с тегами, которые клан может использовать |
Примеры использования
Запрос для получения списка участников клана:
Ответ:
Запрос для получения участника клана по steamId:
Ответ:
Ограничения
API SQUAD TOOLS отслеживает адекватность количества отправляемых запросов и может ограничить доступ к API на некоторое время.
| Запрос |
В секунду |
В минуту |
В час |
| users | — | 1 | 6 |
| clans | — | 1 | 6 |
| user | 5 | 300 | 1800 |