REST API¶

Интерфейс для интеграции: чтение справочников и создание документов из внешней системы.

Адрес¶

Все вызовы идут на https://app.masterkassa.com. Интерфейс и API живут на разных хостах: в браузере открывается один адрес, API отвечает на другом.

Ключ¶

Ключ выдаётся в самом продукте: меню профиля → Настройки пользователя → вкладка Json API → Показать API ключ. Окно спросит пароль пользователя и покажет ключ. Ключ свой у каждого пользователя.

Авторизация¶

Authorization: Bearer <ключ>
Accept: application/json

В пишущих запросах добавляется Content-Type: application/json.

Без заголовка Accept вместо JSON приходит HTML страницы входа, и разбор падает не на коде ответа, а на первом же символе тела.

Ключ наследует права своего пользователя. Один и тот же эндпоинт, вызванный ключом администратора и ключом кассира, ответит по-разному: там, где кассир получает ERROR_USER_ACCESS, операция ему недоступна.

Разделы¶

Быстрый стартПервый запрос целиком, с ключом и разбором ответа. Товары и услугиТовары, группы и бренды: списки, карточка, создание, правка, цены. КонтрагентыСписок, карточка, создание и правка контрагентов. ПродажиЗаказы покупателей, счета покупателям и отгрузки. ЗакупкиЗаказы поставщикам, счета поставщиков и приёмки. ДеньгиПриходные и расходные ордера, входящие и исходящие платежи. ПеремещенияПеремещения товара между складами. ВозвратыВозвраты поставщикам и возвраты покупателей. Расчёт остатковОприходования, списания и инвентаризации. Запись в два шагаОдноразовый токен, обёртка со списком и предел пакета. Границы APIЧего в API нет и где это делается вместо него. Ошибки APIДословные тексты ответов и когда каждый приходит.

Всего операций — 31.