Интеграция через REST API
15 публичных эндпоинтов с аутентификацией по API-ключу. Работает с любым серверным языком или платформой. Спецификация OpenAPI 3.1 включена.
Создайте собственную интеграцию
Если у нас нет нативного модуля для вашей платформы, REST API охватывает любые сценарии использования.
15 эндпоинтов
CRUD для индексов, CRUD для документов (одиночный и массовый), поиск, мульти-поиск, аналитика и управление API-ключами.
OpenAPI 3.1
Машиночитаемая спецификация по адресу /api/v1/openapi.json. Генерируйте клиент на Python, Go, Ruby или любом другом языке.
Аутентификация по Bearer-токену
API-ключи с префиксами ss_search_*, ss_connector_* или ss_scoped_*. Каждый префикс предоставляет разные права.
Исходящие вебхуки (скоро)
Получайте вебхук по завершении синхронизации, при срабатывании квотного оповещения или окончании переиндексации. Сейчас доступен Connector API для опроса.
Заголовки лимита запросов
Заголовки X-RateLimit-Limit и X-RateLimit-Remaining в каждом ответе. Retry-After при ответе 429.
Версионирование API
Все публичные эндпоинты находятся под /api/v1. Ломающие изменения получают новый версионный префикс. Старые версии поддерживаются 12 месяцев.
Начать за 3 шага
Интегрируйте AACsearch в любой бэкенд с помощью нашего REST API.
- 1
Шаг 1
Создайте API-ключ
Создайте API-ключ в панели управления AACsearch. Перейдите в Настройки → API-ключи → Создать ключ.
- 2
Шаг 2
Аутентифицируйте запросы
Используйте аутентификацию Bearer token. curl -H "Authorization: Bearer ss_search_..." \ https://api.aacsearch.com/v1/indexes/my-index/search
- 3
Шаг 3
Сделайте первый запрос
Вызовите эндпоинт поиска. curl -X POST https://api.aacsearch.com/v1/indexes/my-index/search \ -H "Authorization: Bearer ss_search_..." \ -H "Content-Type: application/json" \ -d {"q": "running shoes", "limit": 10}
Часто задаваемые вопросы
Запустите Search OS за один вечер
Создайте индекс, добавьте документы и подключите поиск из приложения. Бесплатного тарифа достаточно для прототипа.