VimeWorld.ru Public API

README.md

Общая информация

API находится по адресу http://api.vime.world/. Чтобы как-то им воспользоваться, в конец адреса нужно добавить имя метода с данными (если есть). Список методов размещен ниже. При вызове методов могут возникать ошибки, с ними можно ознакомиться в errors.md.

Удобство разработки

Чтобы было удобнее смотреть ответ сервера, можете установить расширение для Chrome - JSON Formatter. Оно будет форматировать json в человекочитаемый вид, так что можно будет прямо из браузера тестировать методы и сразу смотреть на результат.

Лимит на количество запросов

При использовании API без токена авторизации, вы можете делать не более 60 запросов в минуту с одного IP. С использованием токена лимит запросов в минуту увеличивается до 600. Если вам все равно этого мало, можете написать одмену в вк https://vk.com/xtrafrancyz и договориться о персональном лимите.

Вы можете посмотреть в заголовки(headers) любого запроса, чтобы узнать текущий статус ограничения:

X-RateLimit-Limit: 60 - количество возможных запросов в минуту
X-RateLimit-Remaining: 59 - количество оставшихся запросов
X-RateLimit-Reset: 1481809432 - Unix TimeStamp, когда лимит будет сброшен, часовой пояс - GMT+0

Авторизация (получение и использование токена)

Для получения токена необходимо зайти на сервер MiniGames и написать команду /api. Вам будет выдана ссылка на страницу, где будет написан ваш токен и информация о нем. Чтобы выполнять запросы с токеном, необходимо добавить его в параметры запроса, например http://api.vime.world/user/1?token=mytoken123

Список методов

Игроки /user

Метод Краткое описание
http://api.vime.world/user/name/{names} Информация об игроках по их никам
http://api.vime.world/user/{ids} Информация об игроках по их id
http://api.vime.world/user/{id}/friends Список друзей игрока
http://api.vime.world/user/{id}/stats Статистика игрока по мини-играм
http://api.vime.world/user/{id}/achievements Выполненные достижения игрока

Разное /misc

Метод Краткое описание
http://api.vime.world/misc/games Список игр, по которым ведется статистика
http://api.vime.world/misc/achievements Список всех возможных достижений
http://api.vime.world/misc/online Количество игроков онлайн с разделением по играм
http://api.vime.world/misc/onlineStreams Список стримов, которые в данный момент идут на сервере