Что такое API

Что проверяют

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

Как отвечать

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

Виды, которые стоит перечислить: HTTP-интерфейсы в стиле REST с ресурсами, методами, кодами ответа и JSON; SOAP с описанием в WSDL и строгим XML; GraphQL с одной точкой входа и выбором нужных полей; обмен через брокер сообщений, когда ответ не нужен немедленно. Отдельно стоит сказать, что API бывает и внутренним: библиотечный, системный.

Что аналитик обязан зафиксировать в постановке: перечень операций и кто инициатор; поля с типами, обязательностью и примерами; справочники и сопоставление кодов между системами; сценарии ошибок и что делать клиенту; повторная отправка и идемпотентность; авторизация, лимиты и ожидаемое время ответа; версионирование и порядок изменения контракта.

Хорошая привычка называть источник истины: спецификация OpenAPI рядом с кодом, а не таблица в почте.

Где спотыкаются

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

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

Называют REST любым JSON поверх HTTP и не могут объяснить, чем ресурс отличается от действия. На практике это выливается в глаголы в путях и в спор на ревью контракта.