GreenCubes API

[Kernel]

Привет. Сегодня, наконец то, после достаточно неспешной разработки я готов вам презентовать GreenCubes API.

Что это?

Интерфейс программирования приложений (иногда интерфейс прикладного программирования) (англ. application programming interface, API [эй-пи-ай]) — набор готовых классов, процедур, функций, структур и констант, предоставляемых приложением (библиотекой, сервисом) для использования во внешних программных продуктах

Проще говоря, это веб-сервис, который поможет сторонним разработчкиам, таким как Allintop с его GCMap, BloodyAvenger и его GC-Card, Astappev с его кучей различных приложений и даже SergAntik с его калькулятором МС, разрабатывать приложения делающие игру на GreenCubes удобнее и веселее.

Окей, мне это интересно, но какой функционал он предоставляет на данный момент?
API предоставляет доступ к следующим функциям:

1. User API — Основная информация об игроке: дата регистрации, последний вход игрока на всех серверах, префикс и его цвет, цвет ника, URL скина и никнейм с правильным регистром
   Хочу нормальный CSS и HTML для вёрстки текста! И markdown в студию!
2. GC.Main API — API Main сервера. Состояние сервера и количество игроков. Статистика по экономике (редирект на api.php).
3. GC.RPG API — API RPG сервера. Состояние сервера и количество игроков.
4. GC.Apocalyptic API — API Apocalyptic сервера. Состояние сервера и количество игроков.
   CAKE IS A LIE
5. Meta API — Информация о Web-API: текущая версия, адрес документации, авторы.
6. Rate Limit API — Информация о лимите запросов для текущего IP.
   БАДНИК КОРОЛЬ
7. Авторизация через OAuth 2.0 — Да-да. Это именно то, о чём вы подумали. Это самая настоящая авторизация через ваш GreenCubes аккуант.
   В данный момент нет способа зарегистрировать своё приложение. Для регистрации приложений и дополнительной информации прошу ко мне в ЛС.

Ого! А где я могу почитать полную документацию?
Документация писалась параллельно с разработкой и находится вот тут. Вероятно, может содержать в себе неточности и ошибки, ибо разработка велась по ночам Если таковые будут найдены, то просьба сообщить о них мне в ЛС.

А, это и есть то самое "тестовое испытание"?

«Пятый админ» (c). Я уже обмолвилась, что у нас в команде разработки прибавление, но оно пока не официальное, потому что тестовое испытание ещё не пройдено. Надеюсь, скоро вы увидите то, над чем сейчас работает новый член нашей команды, а после чего мы расскажем, над чем он будет работать. Пока ни каких сроков, к сожалению.

— Источник

Нет, это не оно. Первая концепт-версия была написана ровно месяц назад (нет, серьёзно) и постепенно дорабатывалась. API это проект изначально сделанный почти за одни выходные, чтобы проверить свои текущие знания по node.js и просто решить одну из проблем, которую я поставил перед собой давным давно. Однако, вернёмся к "тестовому заданию", это будет проект немного масштабнее и сложнее, он будет направлен на всю аудиторию ГК, а не только на разработчиков.

Как скоро будет выпущено? Когда это потребуется.

UPD: А вот и оно.

Хочу немного технической информации!
Проект написан на node.js с использованием фреймворка Sails.js. Ни одна Кошка не пострадала во время разработки.

Да, я тоже буду выкладывать красивые скриншоты с GitHub. К примеру, как этот:


Куда присылать багрепорты?
Багрепорты лучше присылать мне сигнальной ракетой или ещё чем нибудь со скоростью света, но можно обойтись личными сообщениями на форуме, твиттером и даже капсом мне в игровую личку (если поймаете).

В данную тему вы можете написать свои пожелания, предложения и что нибудь ещё не выходящее за пределы тематики.

[benseeley]

:О и да, такого твиттера не существует.

[Kernel]

Поправил.

[benseeley]

[Kernel]

У меня всё отлично открывается о_О.

[benseeley]

через минуту упорного тыканья по ссылке, таки открылось, да.

[astappev]

Ну, как же не вовремя... и так времени нет... а теперь еще и это... ну ладно, ждите новых версий, всей моей «кучи приложений».

[astappev]

Прочел документацию. Впечатление хорошое. Дальше будет видно на практике.
Хочу лишь добавить что мне нужен email пользователей. Прошу его добавить ибо я все равно буду требовать его от пользователя (с проверкой). Может не по умолчанию, но для некоторых приложений это будет нужно.

И напише какие данные нужны для регистрации приложения.

[Kernel]

Окей, почему бы и нет. Станет ещё одним scope. Добавлю следующим коммитом.

Для регистрации на OAuth 2.0 сервере понадобится:

• Название приложения.
• Описание приложения.
• RedirectURI, тобишь Callback на который редиректим после получения разрешения у пользователя.
• Требуемые права доступа (aka scopes, может быть profile, email).
• Уберслучайный clientSecret (генерируется сервером).

[Sttrangeman]

И для чего это рядовому юзеру?

[Djzero]

Возможное осознание того, что в будущем не нужно будет регистрировать отдельный аккаунт на проектах, которые связаны с GreenCubes.

[Rena4ka]

И для чего это рядовому юзеру?

это веб-сервис, который поможет сторонним разработчкиам

Почему всё должно быть для рядовых юзеров?

[Sttrangeman]

И для чего это рядовому юзеру?

это веб-сервис, который поможет сторонним разработчкиам

Почему всё должно быть для рядовых юзеров?

Потому что их гораздо больше?

[BloodyAvenger]

[list=1][*] User API — Основная информация об игроке: дата регистрации, последний вход игрока на всех серверах, префикс и его цвет, цвет ника, URL скина и никнейм с правильным регистром

щикарно, будет время изучу подробней что и как.

Ещё бы в API серверов добавили бы список игроков за последний час или какой то другой промежуток времени, возможно это бы с подвигло меня для чего то нового

И мне интересно про авторизацию аккаунтом гк , ибо в последнее время ковыряюсь именно в этом направлении.

И для чего это рядовому юзеру?

это веб-сервис, который поможет сторонним разработчкиам

Почему всё должно быть для рядовых юзеров?

Потому что их гораздо больше?

Но зачем им это ?

[Kernel]

Возможно возьму за привычку писать в конце каждого дня подобные ченджлоги. В реальном времени их всегда можно узреть в моём твиттере.

Не сочтите за особую рекламу моего уютного твиттера, но получать последнюю информацию о такой важной системе как API нужно в максимально короткие сроки. Это позволяет делать исправления своих приложений вовремя, если оно того потребует.

Добавлено

• Новый scope — email. Он позволяет приложению получать ваш email адрес через вызов /user.
  Пользователям: не стоит забывать, что перед тем как дать права на доступ к информации аккаунта, API сначала спросит у вас разрешение на это вот такой страничкой.
• Техн. Новое обязательное поле при регистрации приложения — owner. В базе данных это ваш User ID (приватный, недоступен извне).
• Добавлен форматированный вывод JSON с двумя символами пробелов, как основу форматирования (ранее ответы выводились одной строкой).

Исправлено

• GET /users/:user — Исправлен баг с неверным выводом lastseen у всех серверов. Он показывал дату первого входа. Вывод до 22:15 по МСК был некорректным.
• GET /users/:user — Исправлена обработка запросов с пользователями, которых нет.
• GET /users/:user & /user — Исправлен вывод поля username и skin_url, теперь он использует никнейм с верным регистром.
• Техн. Исправлено получение IP пользователя. Теперь он производится через передачу IP проксирующим сервером в заголовках. Этот баг вызывал проблему общего счётчика лимита запросов (он считал все запросы, которые были получены сервером).
• POST /oauth/token — Добавлены нормальные сообщения об отсутствии какого либо из требуемых элементов запроса [документация]
• В разных частях приложения исправлены HTTP статусы ошибок в соответствии с технической документацией.
• GET /rpg/status — Исправлен вывод всего статуса. До 0:24 16 апреля он выводил информацию о Main сервере.
• GET / — Исправлено описание метода user_url.

[Kernel]

Добавлено

• Ещё одно новое обязательное поле при регистрации приложения — homeURI. Это адрес вашего приложения.

Исправлено

• GET / — Поле user_url снова выглядит так: "https://api.greencubes.org/users/{user}". Кто-то не понимал, что обозначает двоеточие в прошлой версии, ладно.
• Техн. GET /users/:user Добавлена дополнительная проверка экранированной переменной параметра user. Раньше можно было прислать запрос /users/:Kernel и он ответил бы информацией обо мне.

Вроде бы всё теперь неплохо отлажено, осталось начать тесты OAuth 2.0. Однако, теперь я снова больше буду уделять время мистическому приложению.

Также я думаю привести документацию в нормальный читаемый вид.

[Kernel]

Добавлено

• GET /main/named_colors — Список именованных цветов для модификаторов свечения. Для не умеющих в JSON и простых людей есть HTML версия.
  [документация]
• Техн. Портирована библиотека из мистического приложения для работы с БД авторизации.
• Техн. Эта же библиотека получила поддержку работы с другой БД авторизации.

Исправлено

• GET /main/named_colors — Исправлен вывод никнеймов открывателей. Данные о логинах поступали не из той БД. Вывод до 22:23 по МСК был некорректным. Спасибо Венусу за багрепорт.

[AkiraSun]

Вот это крутотень.

[Rena4ka]

И для чего это рядовому юзеру?

Ну например, вот для чего.

Список именованных цветов для модификаторов свечения. Для не умеющих в JSON и простых людей есть HTML версия.

В будущем будет ещё несколько функций, доступных "из коробки". Ну и конечно рядовому юзеру это для того, чтобы не рядовые юзеры сделали что-нибудь интересное для них.

[Kernel]

Сегодня я работал над API меньше всего. Сбавил темп, ибо есть и другие делишки.

Добавлено:

• GET /users/:user & /user — Добавлена конвертация ID базовых ников (1-9 & a-e) в нормальный hex вид.

[benseeley]

почему б не сделать возможность с помощью api узнать, во что одет игрок, чтоб скин корректировать согласно этому? вот у кого-то, например, на скине на голове не нарисованы волосы, и он носит шляпу. но штука для просмотра скинов не видит шляпу...

[Lenald]

Возможность вытягивать цвет и префикс ника - ОЧЕНЬ опасная вещь: даже я с моими знаниями языков могу написать программу для фальсификации чата. Достаточно просто изменить лог, отфильтровать, отформатировать, покрасить текст под желаемый канал, вытянуть цвета, префиксы, наложить на желаемую картинку и заскринить.

[Rena4ka]

И что? Вытянуть их элементарно и без этого. Скрины из чата никогда ничего не доказывают, они легко подделываются.

[firedead_ft]

https://api.greencubes.org/users/Firedead
502

UPD: пофиксилось

[Lenald]

Мне кажется, или скрин чата всегда был лучшим доказательством в банах за маты, оскорбления и пр.?

[greenmine]

Мне кажется, или скрин чата всегда был лучшим доказательством в банах за маты, оскорбления и пр.?

Есть логи чата, так что скриншот всегда можно проверить.

[Lenald]

И как ты предлагаешь проверить личку, или частный канал, или, ещё лучше, локальный?

[BloodyAvenger]

И как ты предлагаешь проверить личку, или частный канал, или, ещё лучше, локальный?

всё пишется в логи и всё можно проверить.
И как уже говорила рена скриншот можно и без этого подделать.

[Kernel]

https://api.greencubes.org/users/Firedead
502

UPD: пофиксилось

Да, я случайно сломал версию на сервере ввиду не очень отработанного тестирования. Надо будет покрыть тестами всё и намертво.

Сейчас всё хорошо, ага.

[deno10]

Мне кажется, надо делать проверку на наличие скина, и при его отсутствии выдавать null