AACSearch
ГлоссарийРазработка и API

Разработка и API

REST, эндпоинты, SDK, пагинация, webhook и интеграция виджета.

Разработка и API

AACSearch можно использовать через готовый виджет или напрямую через API и SDK. Этот раздел — базовый словарь разработчика: как устроен программный интерфейс и как его интегрировать.

Основы API

  • API (application programming interface) — программный интерфейс.
  • REST — распространённый стиль API поверх HTTP.
  • Эндпоинт (endpoint) — один URL-путь API.
  • Метод (method) — HTTP-глагол (GET, POST, PUT, PATCH, DELETE).
  • Запрос (request) — вызов клиента к API.
  • Ответ (response) — ответ сервера.
  • Код статуса (status code) — числовой результат (200 OK, 404 Not Found).
  • Заголовок (header) — пара ключ-значение в метаданных запроса/ответа.
  • Тело (body) — полезная нагрузка запроса или ответа.
  • Параметр запроса (query parameter) — пара ключ-значение в URL.
  • Фильтр API (filter) — параметр, сужающий результаты.

Форматы и схемы

  • JSON — распространённый формат данных API.
  • JSON-поле (JSON field) — одна пара ключ-значение внутри JSON.
  • Схема API (schema) — объявленная форма полезной нагрузки API.
  • OpenAPI — стандарт описания REST API.
  • Ошибка (error response) — структурированная полезная нагрузка об ошибке.

SDK и версии

  • SDK — клиентская библиотека (Node, Go, PHP, Python), оборачивающая API.
  • Клиентская библиотека (client library) — другое название SDK.
  • Пакет (package) — распространяемая единица кода.
  • Версия (version) — нумерованный выпуск API или SDK.
  • Семантическое версионирование (SemVer) — major.minor.patch.
  • Ломающее изменение (breaking change) — изменение, несовместимое со старыми клиентами.
  • Deprecation — пометка функции к удалению.

Пагинация и лимиты

  • Пагинация API (pagination) — постраничный обход результатов.
  • Курсор (cursor) — указатель для пагинации выдачи.
  • Смещение (offset) — позиция, с которой начинается страница.
  • Лимит запросов API (rate limit) — ограничение запросов за период.
  • Заголовок лимита (rate limit header) — метаданные с лимитом и остатком.
  • Retry-after — заголовок, указывающий, когда повторить.

Webhook и события

  • Webhook API — HTTP-обратный вызов на ваш сервер по событию.
  • Подпись (signature) — криптографическая проверка подлинности webhook.

Интеграция виджета

  • Встраиваемый виджет (embed widget)* — готовый интерфейс поиска, подключаемый скриптом.
  • Тег скрипта (script tag) — HTML <script>, загружающий виджет.
  • Публичный ключ/токен (public key / token) — учётные данные, безопасные для клиентской стороны.
  • Секретный ключ (secret key) — учётные данные только для серверной стороны.
  • Переменная окружения (environment variable) — значение конфигурации, заданное вне кода.
  • mCP (model context protocol)* — протокол предоставления инструментов AI-агентам.

Для быстрого старта достаточно виджета; для тонкой настройки и кастомного интерфейса используются API и SDK.

On this page