OneR™ API

Знакомство с OneR™ API

 

Методы и объекты

OneR API — это интерфейс, который позволяет получать информацию из базы данных onertm.xyz с помощью http-запросов к специальному серверу. Вам не нужно знать в подробностях, как устроена база, из каких таблиц и полей каких типов она состоит — достаточно того, что API-запрос об этом «знает». Синтаксис запросов и тип возвращаемых ими данных строго определены на стороне самого сервиса. 

Например, для получения данных о пользователе с идентификатором 210700286 необходимо составить запрос такого вида:

http://api.onertm.xyz/api.php?method=users.get&user_ids=1

Рассмотрим отдельно все его составляющие.

  • http:// — протокол соединения.
  • api.onertm.xyz/api.php — адрес API-сервиса.
  • ?method=users.get — название метода OneR™ API. Методы представляют собой условные команды, которые соответствуют той или иной операции с базой данных — получение информации, запись или удаление. Например, users.get — метод для получения информации о пользователе.
  • user_ids=1 — параметры запроса. После названия метода нужно передать его входные данные (если они есть) — как обычные GET-параметры в http-запросе. В нашем примере мы сообщаем серверу, что хотим получить данные о пользователе с id=1 . Входные параметры всегда перечислены на странице с описанием метода.

В ответ сервер вернет JSON-объект с запрошенными данными (или сообщение об ошибке, если что-то пошло не так). JSON — это формат записи данных в виде пар «имя свойства»: «значение». Если Вы раньше не встречались с этим форматом, мы рекомендуем познакомиться с ним, прежде чем продолжить чтение: JSON, Wikipedia 

Ответ на наш запрос выглядит так:

{"response":{"1":{"status":200,"login":"Эльдарка","name":"Эльдар","nick":"Эльдарка","vk":"id427842281","steam_id":"STEAM_1:1:439777593","steam":"76561198839820915","regdate":"2018-12-13 11:54:45","avatar":"https://onertm.xyz/files/avatars/1553985768.jpg","clan":{"id":7,"role":0}}},"status":200}

Структура ответа каждого метода также строго задана, и при работе с API Вы заранее знаете, что в поле status придет число, а в поле login — строка. Такие правила оговариваются на страницах с описанием метода и соответствующих объектов, которые он возвращает в ответе.

Авторизация пользователя

В общем случае для идентификации в API используется специальный ключ доступа, который называется access_token. Токен — это строка из цифр и латинских букв, которую Вы передаете на сервер вместе с запросом. Из этой строки сервер получает всю нужную ему информацию.

Мы воспользуемся самым простым способом и получим токен для работы с API.

Откройте новую вкладку в браузере и введите в адресную строку такой запрос:

https://onertm.xyz/key

Скопируйте из поля ваш токен, он может выглядеть так:

On40422eR112730

Токен — это Ваш ключ доступа. При выполнении определенных условий человек, получивший Ваш токен, может нанести существенный ущерб Вашим данным и данным других людей. Поэтому очень важно не передавать свой токен третьим лицам. 

Что дальше?

Вы познакомились с основными понятиями, связанными с OneR™ API. Дальше все зависит лишь от Вашего вдохновения. 

Конечно, на практике никто не работает с API из соседней вкладки браузера. Для этого используют самые разные языки программирования, SDK, генераторы кода. Сам механизм работы с API весьма прост, средства для отправки http-запросов и обработки ответа от сервера предусмотрены практически в любой среде разработки: а значит, возможность выбора всегда есть.




OneR™
Яндекс.Метрика