跳到主要内容

公开护照读取

公开护照读取

任何人都可以用这三种方法读取已发布的护照。这些方法不需要 API 密钥。它们使用 EN 18222 的路径,这是护照 API 的欧洲标准。

基础地址

每种方法都从 https://passportcraft.com 开始。品牌自己的护照域名会为该品牌的护照响应相同的方法。

当注册库要求提供护照的 API 端点(EN 18222 中的 dppApiEndpoint)时,请填写这个基础地址。

https://passportcraft.com

方法

  • GET/v1/dpps/{dppId}

    按编号读取一份护照。

  • GET/v1/dppsByProductId/{productId}

    读取一件产品的护照。

  • POST/v1/dppsByProductIds

    查找多件产品的护照编号。

请求
curl "https://passportcraft.com/v1/dpps/https%3A%2F%2Fpassportcraft.com%2Fpassport%2F{id}"
响应
{
  "digitalProductPassportId": "https://passportcraft.com/passport/{id}",
  "uniqueProductIdentifier": "https://passportcraft.com/01/{gtin}",
  "granularity": "model",
  "dppSchemaVersion": "EN18223:v1.0",
  "dppStatus": "active",
  "lastUpdated": "2026-01-01T00:00:00Z"
}

标识符

dppId 是护照的 digitalProductPassportId,需做百分号编码。只用护照的编号同样可以。

productId 是护照的 uniqueProductIdentifier,需做百分号编码。它是护照的 GS1 Digital Link;产品没有条形码时,则是护照地址。

在请求正文中以 JSON 数组发送最多 500 个产品标识符。请将每个标识符按护照给出的原样发送。不要添加两个 GET 方法所需的百分号编码。响应按您发送的顺序列出找到的护照编号。与任何已发布护照都不匹配的产品标识符会被略去。

limit 决定每页读取多少个产品标识符,取值 1 到 100。不填时,每页读取 50 个。只要还有剩余,paging_metadata.cursor 就是下一页要作为 cursor 发送的值。

表示形式

护照默认以压缩形式返回。添加 ?representation=full 可获得完整形式,其中会注明每个元素的类型。

浏览器

偏好 HTML 的请求(例如浏览器的请求)会被重定向到护照页面。

状态码

200护照,或护照编号列表。
303为浏览器重定向到护照页面。
400编号、产品标识符、请求正文或某个查询值无效。
404没有匹配的已发布护照。
405该路径不接受此方法。
500暂时无法读取该护照。请稍后重试。
501EN 18222 定义了此方法,而我们不提供。

除 501 外,每个错误都带有 result 对象。其中是一份消息列表,每条包含 messageType、text、code 和 timestamp。程序应读取 code,它永远不会变。

这些方法只能读取。要创建或修改护照,请使用经过身份验证的 API。