alex-eri/crpt-openapi

TrueAPI Честного знака и API ЭДО Лайт в формате OpenAPI 3.0/Swagger/bruno

★ 0Forks 0GitHub ↗Compare

Project website ↗

README

License Telegram

Infostart

crpt-openapi

Неофициальная OpenAPI-спецификация и Bruno-коллекции для API ГИС МТ «Честный ЗНАК» (ЦРПТ).

Отказ от ответственности

Данный проект не является официальным продуктом ООО «Центр развития перспективных технологий» или ООО «Оператор-ЦРПТ». Спецификации и коллекции подготовлены на основе общедоступной документации и не гарантируют полноту, точность или актуальность. Используйте на свой страх и риск. Для получения официальной информации обращайтесь к первоисточнику.

Первоисточник

Официальная документация API ГИС МТ: docs.crpt.ru/gismt/Раздел_для_разработчиков/

Возможности

  • OpenAPI 3.0 спецификации для True API и ЭДО Лайт в формате YAML
  • Bruno-коллекции с готовыми шаблонами запросов, заголовками, телом и окружениями

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

openapi/
  true-api.yaml      — Спецификация True API
  edo-light.yaml     — Спецификация ЭДО Лайт
bruno/
  true-api/          — Bruno-коллекция True API
    environments/    — Окружения (песочница/продуктив × API v3/v4)
  edo-light/         — Bruno-коллекция ЭДО Лайт
    environments/    — Окружения (продуктив/интеграция)

API

True API

Основной API ГИС МТ для участников оборота товаров. Покрывает:

  • Аутентификация — получение ключа сессии через УКЭП
  • Подача сведений — создание документов, агрегация, упаковка, резервирование партий
  • КИ и товары — проверка, история движения, информация по GTIN, складские остатки, согласия
  • Документы и чеки — статусы, содержимое, списки, валидация УПД
  • Квитанции — результаты обработки документов
  • Выгрузки данных — создание задач, статусы, скачивание ZIP-архивов
  • Национальный каталог — карточки товаров, бренды, атрибуты, фиды
  • Станция управления заказами (СУЗ) — токен аутентификации
  • ЭДО Лайт — получение ID абонента и ZIP-архивов документов

ЭДО Лайт

API электронного документооборота ГИС МТ. Покрывает:

  • Исходящие документы — загрузка, подписание, печать, скачивание УПД/УПДи/УКД/УКДи
  • Входящие документы — загрузка титулов покупателя, печать, скачивание
  • Квитанции — аннулирование, подписание, скачивание JSON/XML
  • Универсальные сообщения — обмен через XML
  • МЧД — машиночитаемые доверенности

Окружения Bruno

Окружение Base URL
Демонстрационный стенд (песочница), API v4 https://markirovka.sandbox.crptech.ru/api/v4/true-api
Демонстрационный стенд (песочница), API v3 https://markirovka.sandbox.crptech.ru/api/v3/true-api
Промышленный стенд, API v4 https://markirovka.crpt.ru/api/v4/true-api
Промышленный стенд, API v3 https://markirovka.crpt.ru/api/v3/true-api
Промышленный стенд ГИС МТ (ЭДО Лайт) https://edo-gismt.crpt.ru
Интеграционный стенд ГИС МТ (ЭДО Лайт) интеграционный стенд

Как использовать

OpenAPI спецификации

Откройте файлы из openapi/ в любом совместимом инструменте:

Bruno коллекции

  1. Установите Bruno
  2. Откройте коллекцию: bruno/true-api или bruno/edo-light
  3. Выберите окружение в выпадающем списке
  4. Настройте токен аутентификации в opencollection.yml

Contributors

pravets

Issues