Регистрация

Для начала работы с API вам необходимо зарегистрироваться в системе Karvon Host. После этого перейдите в раздел “Интеграции” и создайте новый ключ API. Скопируйте ключ и используйте его в запросах к API. Вы сможете увидеть ключ только один раз, поэтому сохраните его в надежном месте.

⚠️

Karvon не хранит ваши ключи API, поэтому если вы потеряете ключ, вам придется создать новый. При создании нового ключа старый ключ будет недействителен.

⚠️

Партнер несет ответственность за безопасность ключа API. Не передавайте ключ третьим лицам.

Авторизация

Для авторизации вам необходимо передать ключ API и Karvon Host ID в заголовке запроса. Пример:

Параметр	Описание
X-API-Key	Ваш ключ API
X-Host-User-Id	Ваш ID (можно найти в настройках)

ℹ️

Без авторизации запросы к API будут отклонены.

Запросы

Все запросы к API должны быть отправлены на адрес https://api.host.gokarvon.com/v1.

Для запросов формата GET параметры передаются в URL. Пример: https://api.host.gokarvon.com/v1/locations/703b44cb-22fa-4228-b3d8-d359bfe5b6bf

⚠️

При ‘GET’ запросах НЕЛЬЗЯ передавать параметры в теле запроса из-за безопасности. Такие запросы будут отклонены.

Для запросов формата POST, PUT, DELETE параметры передаются в теле запроса. Пример:

{
  "key": "value"
}

Ошибки

Для проверки на ошибки используйте поле error. Если error равен 0, значит запрос выполнен успешно. Если error не равен 0, значит произошла ошибка. error также может быть строкой, если произошла ошибка валидации.

В случае возникновения ошибки, вы получите ответ в формате:

{
  "error": 1,
  "message": "Error message"
}

⚠️

Поле message передается не всегда.

Формат времени

Все даты и время передаются в формате RFC 3339 основанной на ISO 8601. Пример: 2025-01-21T04:56:59.641Z

ℹ️

Все даты и время передаются в UTC времени.

API Host