CyfroPass
Ibda

Dokumentazzjoni

Public API

Automate your Digital Product Passports: create and update products, publish passports, read templates and import catalogues over a simple REST API. Authenticate with an API key.

Download OpenAPI spec Endpoint reference

Plan requirement

The API is available on every plan, Free included — tiers differ by the daily quota, not by access. Each request re-checks your live entitlement.

Base URL

All endpoints are served under the /v1 prefix on your CyfroPass domain.

https://<your-domain>/v1

Authentication

Create a key as a workspace owner under Settings → API keys. Send it as a bearer token or in the X-API-Key header. The raw key is shown only once.

Authorization: Bearer cp_live_…
X-API-Key: cp_live_…

Rate limits

Enforcement is a per-UTC-day quota split into writes/day (POST/PATCH/PUT/DELETE) and passport reads/day (GET). Free: 100 writes + 100 reads/day; Starter: 1,000 writes/day, unlimited reads; Business & Scale: unlimited. On the ceiling you get 429 with a daily-limit message; the window resets at 00:00 UTC. Send an Idempotency-Key header on writes to retry safely — the first response is replayed for 24h.

Error envelope

Every error uses a uniform JSON envelope with a stable, machine-readable code.

{
  "error": {
    "code": "not_found",
    "message": "not found"
  }
}

Reference

Endpoints

Products

Manage the product catalogue (SKUs) and the documents attached to each product.

GET /products List products (paginated, filterable).
POST /products Create a product from a template version.
GET /products/{id} Fetch one product.
PATCH /products/{id} Update mutable fields; data is merged.
DELETE /products/{id} Delete a draft product. (409 if published)
GET /products/{id}/documents List a product's documents.
POST /products/{id}/documents Upload a document (multipart, ≤ 25 MiB).
GET /products/{id}/documents/{docID} Download a document.
DELETE /products/{id}/documents/{docID} Delete a document. 
curl https://app.passflow.example/v1/products \
  -H "Authorization: Bearer cp_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Passports

Publish, re-publish and archive passports, and read their immutable version history. Passport routes are keyed by product id.

GET /passports/products/{productID} Current passport (with snapshot).
POST /passports/products/{productID}/publish Publish or re-publish. (422 on validation failure)
POST /passports/products/{productID}/archive Archive the current passport.
GET /passports/products/{productID}/versions Version history (metadata).
GET /passports/products/{productID}/versions/{version} One version's snapshot. 
curl -X POST \
  https://app.passflow.example/v1/passports/products/PRODUCT_ID/publish \
  -H "Authorization: Bearer cp_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Templates

Read the platform-provided, versioned product-group templates and validate product data against them. Templates are read-only over the API.

GET /templates List templates and their versions.
GET /templates/field-types The generic field-type registry.
GET /templates/{id} List versions of one template.
GET /templates/{id}/{version} Full template document (sections, fields).
POST /templates/{id}/{version}/validate Validate data against a version.
GET /templates/{id}/diff Diff two versions (from, to). 
curl https://app.passflow.example/v1/templates/textile/2026-draft-1 \
  -H "Authorization: Bearer cp_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Import

Bulk-import products from a CSV file or a connected Shopify / WooCommerce / PrestaShop store. Every fetch becomes an import job with the same map → validate → execute lifecycle.

POST /import/upload Upload a CSV (multipart, ≤ 10 MB).
POST /import/sources/test Test a store connector.
POST /import/sources/fetch Fetch a store catalogue into a job.
POST /import/{job}/mapping-suggest Suggest a column → field mapping.
POST /import/{job}/validate Validate mapped rows (no products created).
POST /import/{job}/execute Create products from valid rows. (idempotent)
GET /import/{job} Get import job status. 
curl -X POST https://app.passflow.example/v1/import/upload \
  -H "Authorization: Bearer cp_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -F "file=@products.csv"

The complete, machine-readable specification is available as openapi.yaml.