REST API в облаке предоставляет доступ ко всей вашей производственной инфраструктуре, как локальной, так и облачной, связанной с аккаунтом вашей компании.
API предоставляет интерфейс к следующим элементам:
Задачи (Jobs)
Документы (Documents)
Ресурсы (Resources)
Конфигурации (Configuration)
Нестинг (Nester)
Логи (Logs)
Задачи могут ссылаться на один или несколько документов и на ресурсы. Задача содержит список документов и, при необходимости, схему наложения (layout), режим печати, этапы обработки (workflow) и другие инструкции для принтера или режущего устройства.
Структура задачи описывается в XML, для которого предоставляется XSD и документация. Подробную информацию о структуре задачи можно найти в соответствующей документации.
Ресурсы включают такие элементы, как метки, калибровки, шаблоны и т. д. Они версионируются, а их история сохраняется в течение 30 дней. Задачи, документы и устройства не версионируются — их изменения применяются сразу.
Конфигурация включает в себя устройства, очереди и RIP-серверы:
Устройства (Devices) — принтеры и режущие устройства, привязанные к аккаунту. Они привязываются к сайтам, которые идентифицируются по серийному номеру. Перемещение устройств между сайтами доступно только через облачный интерфейс. Однако перемещение между RIP-серверами и настройка устройств возможны через API.
Очереди (Queues) — локальные автоматизированные процессы, доступные через локальные hotfolder'ы. Задачи можно отправлять напрямую на устройство (если они полностью готовы к производству) или в очередь, которая выполнит предварительную обработку, включая наложение (imposition) и настройку режима печати.
RIP-серверы (RIPs) — это компьютеры, выполняющие обработку задач, рендеринг с нужным разрешением и набором чернил, управление цветами и кодирование в формат, поддерживаемый устройством.
API поддерживает облачный нестинг (группировку изображений перед отправкой на печать) перед назначением устройства или сайта. Это позволяет автоматически создавать JIT-нестинг и обрабатывать задачи оптимальным образом.
REST API работает через HTTPS по адресу api.aurelon.com во всех регионах, кроме Китая, где используется api.aurelon.cn. Для аутентификации необходимо передавать специальные заголовки. Подробности об аутентификации приведены в соответствующем разделе документации.
Обратная связь о статусе задач и устройств передается через WebSocket-сервер. Открывая WebSocket-соединение, приложение может подписаться на необходимые события и получать обновления в реальном времени. Подробности о WebSocket API находятся в разделе Notifications.
Вся документация по API доступна на https://api.printfactory.cloud.
В облачном приложении доступен XML-генератор для создания примеров XML. Он помогает формировать основные требования для задач.
Можно найти здесь: app.printfactory.cloud -> вкладка Support -> XML generator.
Postman — позволяет работать с API напрямую, задавая переменные и выбирая регион. После настройки Postman может автоматически сгенерировать код для вызова API на выбранном языке программирования.