WebAPI
From Team Fortress Wiki
Документация по Steam Web API расположена по адресам http://steamcommunity.com/dev (Английский) и http://developer.valvesoftware.com/wiki/Steam_Web_API (Английский). Отображение данных API для каждого формата данных описано в документе по второй ссылке.
Эта страница содержит команды Web API, которые позволяют Вам получать информацию от системы предметов в Team Fortress 2.
Команды к TF2 Web API требуют для функционирования действительный ключ Steam Web API. Вы можете получить Ваш ключ API здесь. Каждая ссылка, данная для примера, будет работать только после того, как Вы замените «XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX» на Ваш ключ API.
Contents |
Общие элементы
Аргументы
Все методы TF2 используют следующие аргументы в своих ссылках:
- Ключ: Ваш ключ Steam Web API. Без этого ключа сервер выдаст сообщение 403.
- Формат (необязательно): Формат возвращаемых данных («json» для JSON, «xml» для XML, или «vdf» для VDF). Структура данных для каждого формата описана здесь: http://developer.valvesoftware.com/wiki/Steam_Web_API#Formats (Английский). Если формат не указан, то данные по умолчанию будут возвращены в формате JSON.
Итоговая структура
Все методы TF2 возвращают объект «result», содержащий код статуса (в «status») и иные данные, которые были запрошены, или, в случае ошибки, сообщение, в котором указано, почему данные не были возвращены (в «statusDetail»).
Терминология
«Разбитая строка» (tokenized string) относится к строке, содержащей знаки, предваряемые символом «#», которые заменяются эквивалентными строками в игровых файлах VDF для выбранного языка. Например, «TF_Weapon_Jar» описано как «Баночное карате» в файле tf/resource/tf_russian.txt (который может быть найден в «team fortress 2 content.gcf»).
Методы
Примечания
Список допустимых идентификаторов
- 440: Team Fortress 2
- 520: Team Fortress 2 Public Beta
- 620: Portal 2
Методы, требующие 64-битные ID пользователя
Если пользовательский 64-битный ID не является легко доступным, его можно получить при помощи перевода OpenID или извлечения из XML-версии профиля пользователя в Steam Community. Это осуществляется при помощи добавления ?xml=1 к ссылке на профиль (например: http://steamcommunity.com/id/stragglerastic?xml=1) и последующего чтения значения, возвращаемого в метке steamID64.
Реализации
- Steam Condenser (Английский) библиотека Ruby, PHP и Java.
- TF2 Web APpy (Английский) небольшой класс Python.
- Steamodd (Английский) модули Python
- libsc (Английский) библиотека Objective-C для iOS (4.0+) и framework для Mac OS X (10.6+)
См. также
- Обратная связь для просьб / предложений / проблем.
- Steam Web API (Английский) больше информации и другие методы.