PassportCraft API
API by PassportCraft · rest
Create and publish Digital Product Passports. A credential reaches only the organizations it holds a grant for. The two category endpoints describe the product itself rather than a tenant, and answer without a credential. Forward compatibility. This document describes what /v1 sends today, and we add to it without warning — every object schema is deliberately open. To stay compatible: - Ignore response fields you do not recognise, rather than rejecting the response. - Treat an unrecognised enum value as a default case, not an error. - Treat identifiers as opaque strings; never parse or pattern-match them. - Do not depend on the ORDER of fields in a JSON object, or on the exact wording of a human-readable error message. Branch on the machine-readable error code instead. - Retry on 429, and on any other refusal that carries a Retry-After header, waiting for the time it names. It is not only a 429 header: a 409 resource_busy, a 503 storage_unavailable and a 503 entitlement_unavailable…
Endpoint: https://passportcraft.com/api/v1
Verification: observed. Source: crawl.
Capabilities (41)
- List product categories.
- Fetch a category field schema.
- List organizations this credential can act for.
- Describe what this credential may do for this organization.
- List the workspace’s custom fields including archived fields.
- List every document in the workspace library.
- Read the organization event feed.
- Give a key access to a client organization.
- End one key's access to one client organization.
- List import jobs.
- Start an asynchronous bulk import.
- Fetch one import job and its progress.
- List passports.
- Create a passport.
- Fetch one passport.
- Apply a JSON Merge Patch to a passport.
- Read the French affichage environnemental state.
- File the French affichage environnemental declaration.
- List documents linked to a passport.
- Create a document and get a signed upload URL.
- Detach a document and delete it from the library when nothing else holds it.
- Fetch the public and GS1 Digital Link URLs.
- Propose changes to a published passport.
- Publish a passport.
- Restore a passport from trash.