Новости

API на VDS: зачем нужен и как использовать?

API на VDS: зачем нужен и как использовать?
10 августа 2021
39 306
Поделиться:

Привет. Меня зовут Арсений, я старший разработчик в Timeweb и мы с командой сделали API, чтобы вам было удобно работать с виртуальными серверами VDS. Сейчас расскажу, что это за зверь.


Что такое API?

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

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

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

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

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

Интерфейс Swagger для работы с API Timeweb

Как можно использовать API в Timeweb?

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

Даже с вашего сайта, мобильного приложения или личного бота в Telegram. Звучит удобно, правда?

Пример запроса.

Скажем, мы хотим получить список своих VDS на аккаунте. Для этого мы используем запрос вида:


Запрос для получения списка VDS на конкретном аккаунте

Теперь выполним сам запрос с необходимыми параметрами:


Сделав запрос без ошибок, мы получим ответа вида:


В параметре "id" ("id": 293399 в этом примере) выведен идентификатор VDS, необходимый для управления сервером

Полный список методов доступен по ссылке: Методы API для VDS

Что нового появилось?

В чате в Telegram вы просили добавить методы для сбора информации о балансе. И проверки количества оставшихся дней до окончания средств.

Реализовано. Можно собирать баланс сразу хоть по 20 или 200 аккаунтам без нужды читать все e-mail или СМС с уведомлениями об оплате :)

Были просьбы и о появлении методов для работы с бэкапами.
Готово, уже на боевой версии. Просто берите и пользуйтесь.

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

Вопрос — ответ

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

Делитесь опытом работы с API в наших социальных сетях: в VK, Facebook, Twitter или Telegram