API и документация

Один ключ. Каждый модуль.

Большинство бизнес-программ предоставляют API для каждого продукта — один для кассы, другой для склада, третий для счетов, каждый со своей аутентификацией и своим представлением о дате. У Kardopal он один. Один и тот же ключ, один и тот же базовый URL и одна и та же грамматика запросов обеспечивают доступ к 129 ресурсам в 29 модулях.

Создать ключ API Посмотрите, что это охватывает
29
Модули
129
Ресурсы
1
Ключ, один базовый URL
200
Строк на страницу, макс.

Почему стоит строить на этом API

Шесть вещей, которые здесь верны, а обычно нет.

Он описывает себя

Обратитесь к базовому URL, и API вернет свой собственный каталог — каждый модуль, который видит ваш ключ, каждый ресурс внутри него, какие поля доступны для поиска и какие для фильтрации. Вам не нужна эта страница, чтобы написать интеграцию; она нужна, чтобы принять решение о ее написании.

Права доступа, которые работают

Области, маршруты и разрешения в приложении генерируются из одного списка, поэтому разрешение не может быть предложено, если за ним нет конечной точки. Ключ, ограниченный товары получает товары — запрос зарплаты возвращает 403, а не пустую страницу без уведомлений.

Единая грамматика запросов, повсюду

поиск, с, до, пропустить и взять означают одно и то же в счетах и в движениях запасов. Изучите структуру один раз, и каждый из 133 ресурсов будет ей соответствовать.

Ваш экземпляр, и только ваш

Каждая таблица содержит идентификатор клиента, и каждый запрос привязан к собственному клиенту ключа, прежде чем он достигнет базы данных. Невозможно ошибиться с межклиентским чтением, потому что нет параметра, который мог бы его запросить.

Поля обеспечивают достоверность данных

Список полей считывается из актуальной схемы при запуске, а не поддерживается вручную. Новая колонка появляется сама по себе; удаленная колонка никогда не оставит висячую ссылку в документации или ошибку 500 при первом вызове.

Только для чтения, по замыслу.

Ключи только читают; они никогда не записывают. Неправильная интеграция не может аннулировать счет или переместить товар. Любое изменение записи происходит через приложение или вход сотрудника, где оно приписывается человеку и попадает в журнал аудита.

Начать с одного запроса

Все является GET-запросом. Если вы можете использовать curl, вы можете использовать это.

GET /api/v1Весь каталог, доступный по вашему ключу
curl https://api.kardopal.com/api/v1 \
  -H "X-API-Key: kp_live_…"
GET /api/v1/meПроверка вменяемости — чей это ключ и что он может прочитать
{
  "authType": "api_key",
  "tenant": { "name": "Nova Retail", "plan": "pro" },
  "scopes": ["items", "sales", "pos"]
}
GET /api/v1/items?search=lamp&take=2Любой ресурс, единый формат
{
  "resource": "items",
  "scope": "items",
  "total": 41,
  "skip": 0,
  "take": 2,
  "hasMore": true,
  "data": [ { "id": "…", "name": "Desk Lamp LED" } ]
}
GET /api/v1/meta/countsКоличество строк на ресурс — посмотрите, какие данные фактически существуют
curl https://api.kardopal.com/api/v1/meta/counts \
  -H "X-API-Key: kp_live_…"

Пять параметров

ПараметрДелаетЗаметки
поискПоиск без учета регистра по всем полям ресурсаКакие это поля, указано в /мета
сТолько записи с этой датыПрименяется к полю, по которому ресурс сортируется
доТолько записи до этой датыОбъединить с с для окна
пропуститьСмещение в наборе результатовПо умолчанию 0
взятьСколько строк возвращатьПо умолчанию 50, максимум 200

Ресурсы также принимают фильтры по точному совпадению для своих объявленных полей — ?status=paid, ?warehouseId=… — и каждый из них указывает, какие это. Каждый ответ списка содержит итого и есть еще, поэтому пагинация — это цикл, а не догадка.

Что охватывает API

29 модулей, 129 ресурса. Каждая карточка — это одно разрешение, которое вы можете предоставить ключу, а серая метка указывает, где те же записи находятся в приложении на вашем телефоне.

Контакты

2

Клиенты, поставщики и сегменты, к которым они относятся.

контактысегменты контактов
контакты Контакты

Товары

7

Каталог: товары, варианты, бренды, прайс-листы и единицы измерения.

товарыкатегориибрендыварианты товаровпрайс-листыединицы+1 еще
товары Товары

Инвентаризация

7

Склады, уровни запасов, перемещения, партии, серийные номера и ячейки.

складыдвижения-запасовостатки на складепартиисерийные номераинвентаризация+1 еще
инвентарь Инвентаризация

Продажи

7

Счета, сметы, заказы, кредитные ноты и платежи.

счетасметызаказы на продажукредит-нотыплатежирегулярные счета+1 еще
продажи Продажи

POS

11

Кассы, смены, чеки, столы и каждая продажа, прошедшая через кассу.

POS-продажиpos-сменыPOS-терминалыпользователи POSPOS-столыPOS-зоны-столов+5 еще
pos POS

CRM

4

Лиды, сделки, воронки продаж и предложения.

лидысделкиворонкипредложения
crm CRM

Закупка

5

Заказы на закупку, запросы, возвраты, счета и платежи поставщикам.

заказы на закупкузапросы-на-покупкувозвраты-покупокСчетаплатежи поставщикам
закупка Закупка

Бухгалтерия

5

Расходы, банковские счета, транзакции и налоговые ставки.

расходыкатегории-расходовбанковские-счетаbank-transactionsналоговые ставки
бухгалтерия Бухгалтерия

Маркетинг

4

Кампании, получатели, целевые страницы и отправки форм.

кампанииполучатели-кампанийлендингиотправленные формы
маркетинг Маркетинг

HR

8

Сотрудники, отделы, отпуска, расчетные листки, посещаемость и найм.

сотрудникиотделыleave-requestsрасчетные листкипосещаемостьвакансии+2 еще
hr HR

Табель учета рабочего времени

2

Учет рабочего времени и проекты, к которым оно относится.

учет-временитабели-проекты
табель учета рабочего времени Табель учета рабочего времени

Проекты

3

Проекты, этапы и связанные с ними затраты.

проектыфазы-проектазатраты по проектам
проекты Проекты

Бронирование

3

Записи на прием, услуги по предварительной записи и персонал, который их оказывает.

бронированияуслуги бронированиязапись сотрудников
бронирование Бронирование

Выездное обслуживание

7

Задания, техники, наряды на работу, контракты и оборудование.

выездные работытехникизаявки на обслуживаниесервисные контрактызаказы-на-работурабочие карты+1 еще
выездное обслуживание Выездное обслуживание

Логистика

5

Отгрузки, водители, транспортные средства, зоны и перевозчики.

отгрузкиВодителитранспортные средствазоны доставкиперевозчики
логистика Логистика

Служба поддержки

5

Заявки, политики SLA, статьи справки и база знаний.

заявкиклиентские заявкисправочные статьибаза знанийsla-политики
поддержка Служба поддержки

Послепродажное обслуживание

5

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

RMAгарантийные-претензиирегистрации гарантииремонтрегистрации-продуктов
послепродажное обслуживание Послепродажное обслуживание

Аренда

3

Арендуемые активы, договоры аренды и их пункты.

активыарендапозиции аренды
аренда Аренда

Ресторан

2

Меню и заказы, сделанные по нему.

пункты менюзаказы меню
ресторан Общепит

Очередь

5

Билеты, услуги, счетчики, филиалы и экраны отображения.

талоны электронной очередиуслуги очередисчетчики-очередиочереди-филиалыдисплеи-очереди
очередь Очередь

Лояльность

6

Участники, аккаунты, уровни, вознаграждения и транзакции баллов.

loyalty-membersсчета лояльностибонусы лояльностиуровни-лояльноститранзакции лояльностиloyalty-coupons
лояльность Лояльность

Локации

2

Объекты и филиалы.

местоположенияфилиалы
местоположения Локации

IOT

6

Устройства, объекты, коробки, оповещения, события и контент для вывесок.

iot-устройстваiot-sitesiot-оповещенияiot-событияIoT-боксыконтент-для-iot-вывесок
iot IOT Hub

AI Studio

3

Сгенерированные активы, проекты, содержащие их, и история заданий.

активы ИИai-проектыai-jobs
ai_studio AI Studio

Коммерция

3

Участники сети, запросы предложений и инкассация.

участники сетизапросы-на-расчетколлекции
торговля Коммерция

Электронная подпись

2

Запросы на подпись и собранные подписи.

запросы на подписьподписи
подпись e-Подпись

Согласования

2

Запросы на утверждение и правила их маршрутизации.

запросы-на-одобрениеправила утверждения
согласования Согласования

Файлы

2

Загруженные файлы и отсканированные документы.

файлысканированные документы
файлы Файлы

Активность

3

Лента активности, журнал аудита и уведомления.

действияжурналы аудитауведомления
По телефону

Каждый модуль, который читает API, ваша команда может открыть на своем устройстве

Обычно это не соответствует действительности. Многие платформы предоставляют широкий API, а затем выпускают мобильное приложение, которое делает три вещи — утверждает, просматривает, уведомляет. Приложение Kardopal — это продукт, а не дополнение: все 29 модулей, упомянутые выше, имеют реальные экраны, и большая часть работы фактически происходит на телефоне.

  • Прочитайте, затем действуйте. Ваша интеграция получает уровень запасов; человек, который должен это исправить, открывает ту же запись, корректирует ее, и она подписывается его именем.
  • Сканируйте, фотографируйте, подписывайте. Сканирование штрихкодов, захват документов и электронная подпись реализованы на телефоне — у них нет достойного настольного аналога.
  • Работа в автономном режиме на кассе. Касса, экран на кухне и табло очереди продолжают работать при нестабильном соединении.
  • Единый вход, единые данные, 20 языков. Включая языки с письмом справа налево, чтобы арабоязычная команда не читала зеркально отображенный макет.
Посмотреть платформу.
Приложение Kardopal, работающее на телефоне

Получение ключа

Откройте приложение, перейдите в «Платформа» → «Ключи API».Ключи создаются владельцем или администратором в вашем собственном клиенте. Никто в Kardopal не выдает их для вас.
Отметьте только те модули, которые необходимы для интеграции.Виджет для витрины магазина требует товары. Ему не нужно hr. Узкие ключи надежны.
Отправляйте его в заголовке, никогда в URL.X-API-Key: kp_live_… — строки запросов попадают в логи, прокси и историю браузера.
Обновите, сначала создав новый ключ.Оба работают одновременно, поэтому вы можете перенаправлять трафик и отзывать старый без простоя.

Создайте что-то на его основе

API документирует себя: создайте ключ в приложении, укажите curl по базовому URL, и он возвращает каждый модуль, ресурс и поле для поиска, к которым этот ключ имеет доступ.

Создать ключ API