Что такое SDK? Комплекты для разработки ПО простыми словами

SDK (набор для разработки ПО) — это готовый инструментарий, который компания предоставляет разработчикам, чтобы они могли пользоваться её сервисом или платформой, не строя всё с нуля. Обычно он включает библиотеку кода для конкретного языка программирования, документацию и примеры, а иногда и дополнительные инструменты, например для тестирования. Когда ваше приложение «использует SDK Stripe», это значит, что ваш код вызывает готовые функции Stripe, а не формирует вручную каждый запрос к API Stripe.

Почему SDK важны, когда вы создаёте приложение с ИИ

Когда вы просите ИИ-конструктор добавить платежи, чат с ИИ, карты или email, он обычно устанавливает SDK этого провайдера и пишет несколько строк, которые его вызывают. Понимание того, что такое SDK, помогает:

• Понимать, что добавляется в проект. SDK — это зависимость, то есть внешний код, на который теперь опирается ваше приложение.
• Замечать, какая настройка нужна. Почти каждому SDK нужен API-ключ, а у многих есть отдельные версии для «сервера» и «браузера» с разными правилами, какие ключи безопасно использовать.
• Просить правильное. «Используй официальный SDK Stripe на сервере» — понятнее, чем «добавь Stripe».
• Читать ошибки. Многие ошибки в приложениях, созданных ИИ, возникают из-за неправильно настроенного, устаревшего или неверно размещённого SDK.

Бытовая аналогия

Представьте, что вы хотите повесить полки.

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

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

SDK, API, библиотека и фреймворк

Эти термины пересекаются, и это путает многих:

SDK обычно содержит библиотеку, а эта библиотека обычно вызывает API. Для веб-сервисов термины «SDK» и «клиентская библиотека» часто используют как синонимы.

Некоторые SDK вообще не связаны с веб-сервисами. Apple и Google публикуют SDK для создания приложений под iOS и Android, которые включают компиляторы, симуляторы и платформенный код. Идея та же: всё необходимое для разработки под их платформу в одном наборе.

Что SDK делает за вас

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

Без SDK вашему коду нужно самому собрать HTTP-запрос: указать URL, добавить секретный ключ в нужный заголовок, отформатировать данные так, как ожидает API, отправить, проверить код статуса, разобрать ответ и повторить попытку, если сеть заикнулась.

С SDK это ближе к одной строке:

const customer = await stripe.customers.create({ email: "lena@example.com" });

За этой строкой SDK берёт на себя:

• Аутентификацию — правильно прикрепляет ваш ключ к каждому запросу
• Форматирование данных — превращает ваши данные в то, что ожидает API, а ответ — обратно в объекты
• Ошибки — переводит коды статусов в понятные типы ошибок, которые ваш код может перехватить
• Повторные попытки — безопасно пробует снова, когда запрос не удался из-за временных причин (многие официальные SDK так делают)
• Типы — в TypeScript сообщает редактору, какие поля существуют, поэтому ошибки видны до запуска кода

Пример: добавляем ответы ИИ в приложение поддержки

Вы просите ИИ-конструктор: «Когда клиент отправляет обращение в поддержку, сгенерируй предложенный ответ с помощью ИИ-модели».

1. ИИ устанавливает официальный SDK провайдера модели как пакет в ваш проект (для проектов на JavaScript — из реестра npm).
2. Вы добавляете API-ключ провайдера как секрет проекта. SDK читает его на сервере из переменной окружения.
3. ИИ пишет серверный маршрут, который вызывает SDK с текстом обращения и короткой инструкцией, и сохраняет предложенный ответ в базе данных.
4. Браузер никогда не видит ключ; он обращается только к вашему серверному маршруту.

Если провайдер позже меняет свой API, он обычно выпускает новую версию SDK. Обновить пакет и проверить примечания к выпуску на предмет несовместимых изменений часто достаточно.

Ключевые термины

Распространённые заблуждения

• «SDK и API — это одно и то же». API — это интерфейс сервиса, а SDK — удобный слой поверх него. Большинство веб-API можно вызывать и без SDK, просто это больше работы.
• «Если SDK установлен, интеграция готова». Всё ещё нужны аккаунт у провайдера, правильные ключи и код, который обрабатывает сбои.
• «Любой пакет с правильным названием — официальный». Злоумышленники иногда публикуют похожие пакеты-подделки. Точное имя пакета проверяйте в документации провайдера.
• «SDK для браузера может использовать мой секретный ключ». Никогда. Всё, что есть в коде браузера, видно посетителям. Секретные ключи — только в серверном коде; см. как хранить API-ключи в безопасности.
• «SDK никогда не нужно обновлять». Старые версии перестают получать исправления и в конце концов перестают работать, когда провайдеры отключают старые версии API.

Что спросить у вашего ИИ-конструктора

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

SDK в Mythex

Агент Mythex может устанавливать пакеты в песочницу вашего проекта через обычный менеджер пакетов для вашего стека, включая SDK провайдеров — назовите пакет и функцию, для которой он нужен. См. Использование пакетов npm. Mythex не поставляет каталог готовых интеграций для вашего приложения: вы сохраняете ключ провайдера как секрет проекта и просите агента вызывать сервис на стороне сервера, как описано в Integrate any API.

О слое под SDK читайте в статье что такое API. Про две частые функции на основе SDK см. как добавить платежи в приложение и как использовать API LLM.

Вопросы