API — это дверь между программами. Вместо того чтобы человек нажимал кнопки на экране, одна программа отправляет запрос в договорённой форме, а другая отвечает в договорённой форме. Ключевое слово здесь — интерфейс: он описывает, о чём можно спросить и что придёт в ответ, но не то, как этот ответ получается.

Сокращение расшифровывается как Application Programming Interface. Его используют для самых разных вещей: от функций, которые предлагает язык программирования, до веб-сервисов, которые компании открывают своим клиентам. Эта статья — о втором виде, о веб-API.

Как выглядит веб-API

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

GET /api/sites HTTP/1.1
Authorization: Bearer YOUR_KEY

200 OK
{"sites": [{"name": "Shop", "status": "up"}]}

Запрос называет, что нужно (адрес и метод), и подтверждает, кто спрашивает (ключ). В ответе есть код, который говорит, получилось ли. Что значат эти числа, смотрите в статье о кодах ответа HTTP.

Для чего нужен API

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

Только чтение и чтение с записью

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

Частые заблуждения

  • «API — то же самое, что сайт». Сайт сделан для того, чтобы его читали люди. API сделан для программ, и страниц у него обычно нет совсем.
  • «Ключ — то же самое, что пароль». Ключ определяет программу и то, что ей разрешено. Хранить его нужно так же тайно, как пароль, но обычно его создают для одной цели, чтобы можно было отозвать, не трогая ничего другого.
  • «Любой API — это REST». REST — один из стилей веб-API. Многие API называют REST, хотя следуют лишь части его правил, а другие устроены по-другому.

API и мониторинг

Мониторинг и API встречаются в двух местах. Монитор может проверять, что API отвечает правильно и быстро, потому что сломанный API ломает всё, что на нём построено. А сервис мониторинга может предложить собственный API, чтобы вы читали его результаты в других инструментах.

В UptimeWire на тарифах Business и Agency есть API только для чтения. Через него ваши собственные инструменты читают данные мониторинга вашего аккаунта. Изменить в аккаунте он ничего не может, а его ключи отдельные от ключей подключения MCP для ИИ-помощников.