НАЧАЛО РАБОТЫ

Vector API

Единый интерфейс для документов, коллекций и событий. Создавайте интеграции, которые остаются предсказуемыми при росте данных.

Начать за 5 минут →
i

Версия 2.4 стабильна. Для новых интеграций используйте адрес api.vector.example/v2. Версия 1 будет поддерживаться до 1 марта 2027 года.

Как устроен API

Vector использует обычные HTTP-методы и JSON. Каждый объект принадлежит рабочему пространству, а изменения публикуют события, которые можно получить через вебхуки.

Схема движения запроса от приложения через Vector API к коллекциям и событиям

Аутентификация

Передавайте ключ проекта в заголовке Authorization. Ключи различаются по окружениям и набору разрешений. Никогда не размещайте секретный ключ в клиентском коде.

POST/v2/auth/tokens
curl --request POST \
  --url https://api.vector.example/v2/auth/tokens \
  --header 'Authorization: Bearer vct_live_••••' \
  --header 'Content-Type: application/json' \
  --data '{"scope":["collections:read"]}'

Получить коллекции

Метод возвращает доступные коллекции с курсорной пагинацией. Результаты сортируются по дате обновления, от новых к старым.

GET/v2/collections

Параметры запроса

limitinteger · optional

Число объектов от 1 до 100. По умолчанию 20.

cursorstring · optional

Курсор из поля next_cursor предыдущего ответа.

statusenum · optional

active archived Фильтр по состоянию.

Ошибки

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

HTTPКодОписание
400invalid_requestПараметры запроса не прошли проверку.
401invalid_tokenКлюч отсутствует, отозван или просрочен.
429rate_limitПревышен лимит запросов для проекта.