API and JSON-LD

The DPP module exposes REST and GraphQL endpoints for machine-readable passports.

REST API

Standard JSON:

GET /rest/V1/dpp/passport/{sku}

JSON-LD with semantic context:

GET /rest/V1/dpp/passport/{sku}/jsonld

Listing with search criteria:

GET /rest/V1/dpp/passports?searchCriteria[pageSize]=10

Optional store context can be passed as query parameter where supported (for example ?storeId=1).

GraphQL

Example query:

query { dppPassportBySku(sku: "SKU-123") { passport_id status template_code completeness_score } }

GraphQL query:

  • dppPassportBySku(sku: String!, storeId: Int): DppPassport

Notes

  • REST/GraphQL output is limited to published passports
  • JSON-LD output includes @context for interoperability
  • Passport listing (/rest/V1/dpp/passports) is also restricted to published records

Found an issue with this documentation? Let us know