Интеграция
Три операции по токену — и файлы, которые не надо чинить
API закрывает то, что делает машина: спросить остаток, забрать коды, проверить код. Всё остальное — загрузку файлов, создание артикулов, отмену выгрузок — делают люди в интерфейсе, и это решение, а не пробел.
Что умеет API
Авторизация — заголовок Authorization: Bearer. У токена собственная роль: «только чтение» или «оператор», и она проверяется той же функцией, что и роль человека.
GET/api/v1/stock
Остатки
Доступно, выведено, списано и всего — по каждому артикулу.
POST/api/v1/issue
Выгрузка
Тот же FIFO и та же транзакция, что и в интерфейсе. Возвращает номер выгрузки и коды в выбранном формате разделителя.
GET/api/v1/codes/{код}
Проверка кода
Код можно передать в любом написании. Отсутствующий код — это ответ 200 с признаком «не найден», а не 404: ломать это ради единообразия значило бы ломать работающую интеграцию.
Справочник — внутри установки
Что КодКипер принимает
- Коды: .csv и .txt, разбор построчно, кодировка UTF-8 (в том числе с BOM); размер файла — 16–128 МБ, по тарифу
- Коды: чтение .xlsx не поддерживается — только .csv и .txt
- Справочник артикулов: .csv, .txt и .xlsx (первый видимый лист, до 20 000 строк и 64 колонок)
- Табличные файлы с кодировкой Windows-1251 распознаются автоматически
- Формат .xls (OLE2) отвергается с указанием, как пересохранить файл
Что отдаёт
- Файл кодов: без заголовка, без кавычек, один код в строке, перевод строки CRLF, BOM по выбору
- Разделитель 0x1D — настоящий байт: этого формата ждёт программа печати
- Разделитель «<GS>» — текстовая запись: файл читается в Excel и «Блокноте»
- Без разделителей — подходит только для сверки, не для печати
- Один артикул — CSV, несколько — ZIP с отдельным файлом на артикул
- Отчёты и журнал: CSV в UTF-8 с BOM, разделитель «;», CRLF — открывается в Excel как есть
Файл кодов никогда не разбирается как CSV
Пределы, которые важно учесть в интеграции
От тарифа зависят: объём хранилища кодов, число пользователей, число токенов API, выгрузка кодов за период подписки, глубина журнала, размер файла кодов, частота запросов к API — все они указаны на странице цен, для каждого тарифа отдельно. В таблице ниже от тарифа зависит только размер файла кодов; остальные её строки одинаковы во всех тарифах.
- Размер файла кодов
- 16–128 МБ, по тарифу
- Форматы файла кодов
- .csv, .txt
- Длина серийного номера
- 1–20 символов
- Строк в одной выгрузке
- 300
- Кодов в одной строке выгрузки
- 1 000 000
- Кодов в массовой проверке
- 50 000
- Строк в читаемом .xlsx
- 20 000 строк, 64 колонки
- Длина артикула
- 120 символов, при загрузке файла — 64