Стандарты

API Kroncl во всех своих методах соблюдает определённые стандарты, включая единый формат ответов, пагинацию и формат временных меток. Соблюдение этих стандартов является главной причиной, по которой разработчик, вызывающий тот или иной метод, может быть уверен в том, что API вернёт данные в определённом формате. Это, в свою очередь, даёт возможность корректно обрабатывать все ответы, избегая неожиданных проблем с форматами.

Версионирование

Текущая стабильная версия API Kroncl — v1. Версия используется в BASE_URL API. Мажорные версии, ломающие обратную совместимость, появляются крайне редко — мы уведомляем разработчиков о таких событиях релизами на официальном GitHub и по почте.

Используйте текущий BASE_URL как константу с версией v1.

Ответы методов

Для ответов большинства методов (за исключением методов, возвращающих бинарные данные) используется кодировка application/json. HTTP-статусы соответствуют классической методологии REST: 2xx, 4xx, 5xx.

Методы этого API возвращают данные в едином формате ответов, структура которого одинакова как в случае ошибок, так и в случае успеха.

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

Для большего понимания приведём примеры ответов API:

{
    "status": true,
    "message": "Success",
    "data": {
        "status": "ok",
        "timestamp": "2026-06-13T15:14:24Z"
    },
    "meta": {
        "timestamp": "2026-06-13T15:14:24Z",
        "request_id": "e08cf60221af/7tXcx4SYpF-005807",
        "path": "/api/v1/health",
        "method": "GET"
    }
}

Пагинация

Многие методы API используются для получения коллекций объектов. Это API использует page pagination — 4 параметра в массиве pagination внутри поля data ответа:

Для запросов используется 2 параметра в URL метода:

Примеры пагинации

Для понимания работы пагинации приведём пример ответа одного из методов:

{
    "status": true,
    "message": "Invitations retrieved successfully",
    "data": {
        "invitations": null,
        "pagination": {
            "limit": 10,
            "page": 2,
            "pages": 1,
            "total": 0
        }
    },
    "meta": {
        "timestamp": "2026-06-13T15:29:02Z",
        "request_id": "e08cf60221af/7tXcx4SYpF-005900",
        "path": "/api/v1/account/invitations",
        "method": "GET"
    }
}

Временные метки

Для всех временных меток этого API используется формат RFC 3339. Приведём примеры:

• 2026-04-24T00:20:54.94462Z
• 2026-06-13T15:29:02Z
• 2026-06-13T15:13:40.340089Z