KronclAPI
Мои приложения
Введение
Публичные методы
Аккаунт
Компания
Базовые действия
GET Получение компании
PATCH Обновить
GET Разрешения компании
POST Удалить
Хранилище
Тарификация
Участники
Логи
Документы
Поддержка
Персонал (HRM)
Финансы (FM)
Клиенты (CRM)
Склад (WM)
Сделки (DM)
Создать приложение
Документация API платформы. Последняя сборка v1.5.30

Базовые действия

Базовые методы для управления организацией.

# Получение компании

GET
/companies/{id}

Возвращает данные организации. Аккаунт должен быть участником.

Структура ответа

COMPANY:
application/json
idrequired
string
ID
Уникальный идентификатор организации
namerequired
string
Название
Наименование организации
slugrequired
string
Slug
Уникальный латинский код
descriptionrequired
string
Описание
Краткое описание деятельности
avatar_urlrequired
string
Аватар
URL логотипа
is_publicrequired
boolean
Публичность
Публичная ли компания
regionrequired
string
Регион
Основной рабочий регион
siterequired
string
Сайт
URL сайта
emailrequired
string
Почта
Контактный email
role_coderequired
enum
ownerguest
Роль
Роль аккаунта в организации
joined_atrequired
string
Вступил
Дата вступления (RFC 3339)
created_atrequired
string
Создана
Дата регистрации (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)

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

200
403
{
    "status": true,
    "message": "Company retrieved successfully",
    "data": {
        "id": "660e8400-e29b-41d4-a716-446655440020",
        "name": "Автосервис на Пушкина",
        "slug": "auto-pushkina",
        "description": "Ремонт и обслуживание легковых автомобилей.",
        "avatar_url": "",
        "is_public": true,
        "region": "РФ",
        "site": "",
        "email": "",
        "role_code": "owner",
        "joined_at": "2026-04-24T00:20:54Z",
        "created_at": "2026-04-24T00:17:05Z",
        "updated_at": "2026-06-13T15:29:02Z"
    },
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/...",
        "method": "GET"
    }
}

# Обновление

PATCH
/companies/{id}

Обновляет данные организации. Все поля опциональны.

Структура запроса

UPDATE_REQUEST:
application/json
nameoptional
string
Название
Новое наименование
descriptionoptional
string
Описание
Новое описание
regionoptional
string
Регион
Новый регион
is_publicoptional
boolean
Публичность
Сменить видимость
siteoptional
string
Сайт
Новый URL сайта
emailoptional
string
Почта
Новый контактный email

Структура ответа

COMPANY:
application/json
idrequired
string
ID
Уникальный идентификатор организации
namerequired
string
Название
Наименование организации
slugrequired
string
Slug
Уникальный латинский код
descriptionrequired
string
Описание
Краткое описание деятельности
avatar_urlrequired
string
Аватар
URL логотипа
is_publicrequired
boolean
Публичность
Публичная ли компания
regionrequired
string
Регион
Основной рабочий регион
siterequired
string
Сайт
URL сайта
emailrequired
string
Почта
Контактный email
role_coderequired
enum
ownerguest
Роль
Роль аккаунта в организации
joined_atrequired
string
Вступил
Дата вступления (RFC 3339)
created_atrequired
string
Создана
Дата регистрации (RFC 3339)
updated_atrequired
string
Обновлена
Дата последнего обновления (RFC 3339)

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

200
403
{
    "status": true,
    "message": "Company updated successfully",
    "data": {
        "id": "660e8400-e29b-41d4-a716-446655440020",
        "name": "Автосервис на Пушкина",
        "slug": "auto-pushkina",
        "description": "Обновлённое описание.",
        "avatar_url": "",
        "is_public": false,
        "region": "РФ",
        "site": "https://auto-pushkina.ru",
        "email": "info@auto-pushkina.ru",
        "role_code": "owner",
        "joined_at": "2026-04-24T00:20:54Z",
        "created_at": "2026-04-24T00:17:05Z",
        "updated_at": "2026-06-14T12:00:00Z"
    },
    "meta": {
        "timestamp": "2026-06-14T12:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/...",
        "method": "PATCH"
    }
}

# Разрешения компании

GET
/companies/{id}/permissions

Возвращает список разрешений, доступных аккаунту в рамках организации.

Структура ответа

PERMISSION:
application/json
coderequired
string
Код
Уникальный код разрешения
lvlrequired
int
Уровень
Минимальный уровень тарифа
criticalityrequired
int
Критичность
Степень важности (1-10)
allow_expiredrequired
boolean
Просроченный доступ
Доступно ли после окончания тарифа

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

200
{
    "status": true,
    "message": "Permissions retrieved successfully",
    "data": [
        {
            "code": "fm.transactions.create",
            "lvl": 1,
            "criticality": 8,
            "allow_expired": false
        },
        {
            "code": "fm.analysis",
            "lvl": 1,
            "criticality": 5,
            "allow_expired": true
        }
    ],
    "meta": {
        "timestamp": "2026-06-14T00:00:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../permissions",
        "method": "GET"
    }
}

# Удаление

POST
/companies/{id}/delete

Безвозвратно удаляет организацию и все её данные.

Структура ответа

DELETE_RESPONSE:
application/json
company_idrequired
string
ID компании
Идентификатор удалённой организации
droppedrequired
boolean
Удалена
Флаг успешного удаления

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

200
403
{
    "status": true,
    "message": "Company deleted successfully",
    "data": {
        "company_id": "660e8400-e29b-41d4-a716-446655440020",
        "dropped": true
    },
    "meta": {
        "timestamp": "2026-06-14T12:05:00Z",
        "request_id": "...",
        "path": "/api/v1/companies/.../delete",
        "method": "POST"
    }
}