Справочник API

Параметры

Создать параметр

HTTP

POST /variables Создаёт новый параметр.

Авторизация

string required

bearerAuth JWT-токен

Тело запроса (application/json):

id (string · uuid) — уникальный идентификатор параметра
name (string) — имя параметра (напр.: API_KEY)
value (string | nullable) — значение параметра
type (string) — тип переметра (напр.: string, number)
createdDate (string · date-time) — дата/время создания
updatedDate (string · date-time) — дата/время обновления

Коды ответов:

200 — параметр успешно создан (application/json)
400 — некорректное тело запроса
422 — ошибка валидации
500 — внутренняя ошибка сервера

POST /variables HTTP/1.1
Authorization: Bearer JWT
Content-Type: application/json

Пример запроса

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "API_KEY",
  "value": "my-secret-key",
  "type": "string",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Пример ответа (200)

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "API_KEY",
  "value": "my-secret-key",
  "type": "string",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Список параметров

HTTP

GET /variables Возвращает список всех параметров.

Авторизация

string required

bearerAuth JWT-токен

Коды ответов:

200 — успешная операция (application/json, массив объектов)
500 — внутренняя ошибка сервера

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

[
  {
    "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
    "name": "API_KEY",
    "value": "my-secret-key",
    "type": "string",
    "createdDate": "2024-08-24T14:15:22Z",
    "updatedDate": "2024-08-24T14:15:22Z"
  }
]

Обновить переметр по ID

HTTP

PUT /variables/{id} Обновляет указанный параметр.

Авторизация

string required

bearerAuth JWT-токен

Параметры пути

id (string) — Variable ID

Тело запроса (application/json):

Те же поля, что и при создании.

Коды ответов:

200 — переменная успешно обновлена (application/json)
400 — некорректный ID или тело запроса
404 — переменная не найдена
500 — внутренняя ошибка сервера

PUT /variables/{id} HTTP/1.1
Authorization: Bearer JWT
Content-Type: application/json

Пример запроса

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "API_KEY",
  "value": "my-secret-key",
  "type": "string",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Пример ответа (200):

{
  "id": "cfd531e0-82fc-11e9-bc42-526af7764f64",
  "name": "API_KEY",
  "value": "my-secret-key",
  "type": "string",
  "createdDate": "2024-08-24T14:15:22Z",
  "updatedDate": "2024-08-24T14:15:22Z"
}

Удалить переменную по ID

HTTP

DELETE /variables/{id} Удаляет указанный параметр.

Авторизация

string required

bearerAuth JWT-токен

Параметры пути

string required

id (string) — Variable ID

Коды ответов:

200 — параметр удалена (без содержимого)
400 — некорректный ID
404 — параметр не найден
500 — внутренняя ошибка сервера

Обновление или вставка истории

БД векторов