Выпущен API по требованию версии 2.0 + практическое руководство пользователя

Какие новости?

Недавно выпущенная версия 2.0 содержит множество изменений и функций, о которых просили наши клиенты:

Получение вашего бесплатного токена

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

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

Пошаговое руководство

Приведенные ниже шаги покажут, насколько легко взаимодействовать с API.

На странице документации вы сможете просмотреть спецификации.

1. Подтвердить

Каждый вызов должен быть аутентифицирован, поэтому вам нужно поместить токен, который вы хотите использовать, в контексте. Просто вставьте токен в указанную форму и нажмите кнопку «Сохранить». С этого момента все обращения в службу будут привязаны к вашей учетной записи.

2. Просмотреть все доступные услуги.

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

3. Войдите в режим тестирования.

Нажмите кнопку «Попробовать», чтобы активировать тестовый режим, и вы сможете отправлять запросы в реальном времени.

Когда вы находитесь в тестовом режиме, у вас будет спецификация запроса в центральном столбце и текстовое поле с полезной нагрузкой вашего запроса справа. Он будет предварительно заполнен тестовыми значениями, которые вам нужно будет настроить.

4. Пример тестового случая.

Один из простейших сценариев - попытаться выяснить текущее положение конкретного самолета.

Мы отредактировали образец полезной нагрузки, удалив все, кроме наших критериев: получить текущую позицию для самолета с бортовым номером G-TTNG. После нажатия кнопки «Отправить запрос» мы должны получить ответ в течение нескольких секунд. Если все пойдет гладко, мы должны увидеть код состояния запроса и полезные данные ответа, появляющиеся под начальным запросом.

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

Реализация собственного клиента

Показанный выше интерфейс отлично подходит для прототипирования ваших вызовов, но, конечно, вам все равно нужно реализовать свой собственный клиент API. Мы покажем, как легко получить полный Python API SDK, работающий всего с несколькими строками кода.

Вы можете загрузить клиент веб-службы на своем любимом языке / платформе - в настоящее время мы поддерживаем самые популярные из них, такие как C #, Java, PHP, Python, Scala, Swift и Javascript.

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

Файл README.md содержит ценную информацию и адаптирован к интересующей нас структуре. В этом случае есть инструкции о том, как настроить среду Python, чтобы иметь возможность беспрепятственно запускать клиент API. Есть также фрагменты кода, которые вы можете скопировать / вставить прямо в свой код.

Мы скопировали фрагменты из файла README в наш собственный файл liveflights-client.py, и нам нужно было только добавить две вещи: строку аутентификации (токен-носитель) и параметр поиска (регистрация «G-TTNG»), то же самое. как вызов, который мы ранее создали в интерфейсе тестирования.

После сохранения файла мы можем открыть терминал и использовать Python для запуска только что реализованного клиента.

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

Также ознакомьтесь с нашей подборкой практических примеров и распространенных вариантов использования, посетив https://www.radarbox.com/blog/on-demand-api-v2-examples