#Проверить ключ

POST /v1/search/credentials/:id/test

Проверяет, принимает ли провайдер сохранённый BYOK-ключ. Внутри отправляет минимальный валидационный запрос к API провайдера и возвращает результат. Поля lastVerifiedAt и lastError ключа обновляются в любом случае — успешная или нет проверка.

#Параметры

Параметр Тип Обяз. Описание
id (path) string да Идентификатор ключа из ответа `GET /v1/search/credentials` или из ответа на создание

Тело запроса не передаётся. Неизвестные поля игнорируются.

#Примеры

#curl — личный ключ

Terminal 
curl -X POST \
  -H "X-Api-Key: YOUR_API_KEY" \
  https://vibecode.bitrix24.tech/v1/search/credentials/cmol3pnk5001fo70zefbwb6dl/test

#curl — OAuth-приложение

Terminal 
curl -X POST \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  https://vibecode.bitrix24.tech/v1/search/credentials/cmol3pnk5001fo70zefbwb6dl/test

#JavaScript — личный ключ

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/search/credentials/cmol3pnk5001fo70zefbwb6dl/test',
  {
    method: 'POST',
    headers: { 'X-Api-Key': 'YOUR_API_KEY' },
  },
)

const result = await res.json()
if (result.valid) {
  console.log('Ключ принят провайдером')
} else {
  console.error('Проверка не прошла:', result.error)
}

#JavaScript — OAuth-приложение

javascript 
const res = await fetch(
  'https://vibecode.bitrix24.tech/v1/search/credentials/cmol3pnk5001fo70zefbwb6dl/test',
  {
    method: 'POST',
    headers: {
      'X-Api-Key': 'YOUR_APP_KEY',
      'Authorization': 'Bearer USER_SESSION_TOKEN',
    },
  },
)

const result = await res.json()

#Поля ответа

Поле Тип Описание
valid boolean true — провайдер принял ключ. false — провайдер ответил ошибкой
error string | null Текст ошибки провайдера. null при valid: true

#Пример ответа

Успешная проверка:

JSON 
{
  "valid": true,
  "error": null
}

Провайдер не принял ключ:

JSON 
{
  "valid": false,
  "error": "Upstream HTTP 401"
}

#Пример ответа при ошибке

404 — ключ не найден:

JSON 
{
  "error": {
    "code": "CREDENTIAL_NOT_FOUND",
    "message": "cmol3pnk5001fo70zefbwb6dl"
  }
}

#Ошибки

HTTP Код Описание
401 MISSING_API_KEY Отсутствует заголовок X-Api-Key
401 INVALID_API_KEY Неверный API-ключ
401 UNAUTHORIZED Запрос идёт через ключ vibe_app_… без Authorization: Bearer <session_token>
403 SCOPE_DENIED Ключу не хватает скоупа vibe:search
404 CREDENTIAL_NOT_FOUND Ключ с таким id отсутствует у текущего пользователя
429 RATE_LIMITED Превышен общий лимит запросов
500 INTERNAL_ERROR Внутренняя ошибка сервера

Полный список общих ошибок API — Ошибки.

#Известные особенности

Различайте уровни ошибок. HTTP 200 с valid: false — провайдер ответил, но отверг ключ (неверный токен, истекший срок). HTTP 4xx — ошибка авторизации в Vibe API. Проверяйте сначала статус ответа, потом поле valid.

Обновление состояния. При valid: true поля ключа lastVerifiedAt и lastError сбрасываются в текущее время и null. При valid: false — lastVerifiedAt тоже обновляется (как факт проверки), lastError записывается. Получить текущее состояние можно через `GET /v1/search/credentials`.

Проверка не списывает Ꝟ. Эндпоинт делает минимальный валидационный вызов в обход биллинг-цикла, баланс пользователя не меняется.

#Смотрите также