مساعدة NowToPrint
مساعدة NowToPrint
مركز المساعدة
Getting Started
Platform Overview
Marketplace
Print Shop
Prepress
Design Studio
Orders & Delivery
Notifications
Free Tools
Templates
VDP (Variable Data Printing)
Developer & API
API Reference
OpenAPI Explorer & Spec Reference
Webhook Access & DeliveryXJDF API RehberiXJDF Master Data Model
FAQ
Technical Reference
Admin Panel
Developer & API
  1. Developer
  2. OpenAPI Explorer & Spec Reference

OpenAPI Explorer & Spec Reference

Download the published machine-readable contracts for the Partner API, XJDF and PrintTalk layer, and Preflight surface.

المطورdocs3 دقيقة قراءةتمت المراجعة ١٦ أبريل ٢٠٢٦

OpenAPI Explorer & Spec Reference

Use this page as the single public index for NowToPrint machine-readable contracts. Each surface has one canonical download URL and a matching guide for operational context.


Published Resources

ResourcePublic URLGenerated referenceBest for
Partner REST API contract/docs/api/openapi.yamlPartner REST APIPostman import, SDK generation, and QA contract review
XJDF / PrintTalk contract/docs/api/xjdf-openapi.yamlXJDF & PrintTalk APIStandards integrations and capability tooling
Preflight Engine contract/docs/api/preflight-openapi.yamlPreflight Engine APIQueued PDF inspection clients for job submission and polling
XJDF Swagger preview/docs/api/swagger-ui.htmlXJDF integration guideBrowser-based inspection of the XJDF contract

Canonical publication flow

Canonical specs live in docs/api/ in the repository and are mirrored into the public /docs/api/* surface during verification and build. Treat the public URLs on this page as the integration entry point.


Partner REST API

Overview

The Partner API is the primary commercial integration surface for buyers, agencies, white-label partners, and marketplaces.

  • Base URL: https://api.nowtoprint.com/api/v1
  • Authentication: Authorization: Bearer <ntp_test_* or ntp_live_* key>
  • Best for: estimates, RFQs, quote acceptance, orders, and operational webhooks

First request

curl -X POST https://api.nowtoprint.com/api/v1/estimate \
  -H "Authorization: Bearer ntp_test_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "category": "business_cards",
    "quantity": 500,
    "specifications": {
      "paperType": "coated-matte"
    }
  }'

Next reading

  • Partner API overview
  • Partner REST API reference
  • Getting started
  • Authentication

XJDF / PrintTalk API

Overview

The XJDF and PrintTalk layer is designed for standards-based interoperability with MIS, ERP, and workflow systems.

  • Route family: https://api.nowtoprint.com/api/v1/xjdf
  • Authentication: bearer auth or X-API-Key, with mTLS in selected enterprise postures
  • Best for: standards-based job exchange, capability discovery, and external workflow alignment

Explore in the browser

Use the published preview when you need a human-friendly contract walkthrough before importing the spec:

  • XJDF & PrintTalk API reference
  • Swagger UI preview
  • Integration guide
  • Master data model

Preflight Engine API

Overview

The preflight surface is a queued validation contract for PDF inspection, job submission, and status polling.

  • Route family: https://api.nowtoprint.com/api/v1
  • Authentication: bearer token
  • Best for: automated file validation, technical quality checks, and asynchronous analysis

Sample request

POST /api/v1/preflight HTTP/1.1
Host: api.nowtoprint.com
Authorization: Bearer ntp_live_xxxxxxxxxxxxxxxxxxxx
Content-Type: application/json

{
  "fileUrl": "https://cdn.example.com/artwork.pdf",
  "profile": "print_ready"
}

Sample response shape

{
  "jobId": "pref_01js3q7d9w4b2k8m1z0h3v6x7y",
  "status": "queued",
  "submittedAt": "2026-04-16T10:00:00.000Z",
  "links": {
    "self": "/api/v1/preflight/pref_01js3q7d9w4b2k8m1z0h3v6x7y"
  }
}

Generated reference

  • Preflight Engine API reference

Problem details and retries

NowToPrint surfaces integration failures through structured HTTP responses. In general:

  • 400 means payload or schema mismatch
  • 401 means missing or invalid credentials
  • 403 means scope or entitlement mismatch
  • 429 means back off and trust Retry-After
  • 5xx means transient failure or dependency disruption

Use request IDs in logs, keep write operations idempotent, and wire webhooks before production.


Change management

  • Partner API public contract: v1
  • XJDF integration layer: current public v1
  • Preflight surface: current public v3
  • New major route families are used for breaking changes
  • Public contract files are updated before external integration guidance changes

Related: API Reference | Partner API | XJDF API | Webhook Access & Delivery

هل كانت هذه المقالة مفيدة؟

مقالات ذات صلة

  • API Reference
  • OpenAPI Explorer & Spec Reference
  • XJDF Master Data Model
  • IAM Guide
Edit on GitHub

آخر تحديث

Persisted PDF Tools job durumunu sorgula GET

Job'ın güncel durumunu, retry görünürlüğünü, lifecycle geçmişini ve retention zaman bilgisini döner.

Getting Started

Request access, create a key, import the published contract, and send your first Partner API request.

في هذه الصفحة

OpenAPI Explorer & Spec ReferencePublished ResourcesPartner REST APIOverviewFirst requestNext readingXJDF / PrintTalk APIOverviewExplore in the browserPreflight Engine APIOverviewSample requestSample response shapeGenerated referenceProblem details and retriesChange management
Ask AI Assistant