Definition
デジタル製品パスポートAPIはどう構成されていますか。
およそ四つのリソースです。パスポートは製品レコードとそのアクセス方針を保持します。イベントはオブジェクトに起きたことをGS1 EPCIS 2.0としてシリアライズして記録します。クレデンシャルは署名済みの主張をW3C Verifiable Credentialsとして保持します。解決は、GS1 Digital Linkの識別子を、呼び出し元が権限を持つビューへと変換します。
Each serialises somebody else’s standard — EPCIS 2.0, VC 2.0 and GS1 Digital Link — so what you build against these endpoints keeps working against a conforming implementation that is not ours.
モデル
どのリソースがどの問いに答えるか
| Resource | 回答 | 標準 |
|---|---|---|
| Passport | "What is this product, and who may see which part?" | CIRPASS準拠のモデル |
| Event | "What happened to this object, where and when?" | GS1 EPCIS 2.0 (JSON-LD) |
| Credential | "Who asserted this, and can I check it myself?" | W3C Verifiable Credentials 2.0 |
| Resolution | "Someone scanned this — what do they get?" | GS1 Digital Link |
回答
よくある質問
API の中心となるリソースは何ですか。
四つです。パスポートは製品レコードとそのアクセス方針を保持します。イベントはオブジェクトに起きたことをEPCIS 2.0として記録します。クレデンシャルは署名済みの主張をW3C Verifiable Credentialsとして保持します。解決は読み取り経路です。GS1 Digital Linkの識別子を入力し、呼び出し元に応じたビューを返します。
パスポートを更新するのではなくイベントを書くべきなのはどんなときですか。
説明を訂正または補完するときはパスポートを更新してください。何かが起きたとき — 工程の完了、保管者の移転、修理の実施 — にはイベントを書き込んでください。目安として、パスポートの項目は「これは何か」に、イベントは「それに何が起きたか」に答えます。
解決がパスポートの読み取りとは別の関心事であるのはなぜですか。
解決こそがスキャンの動作であり、それは公開・匿名・キャッシュ可能だからです。APIでパスポートを読む操作は認証を伴い、鍵が許す範囲を返します。両者は異なる呼び出し元に異なる保証を提供するため、混同すれば公開経路が非公開経路のコストを背負うことになります。
APIにバージョン管理はありますか。
はい。パスに含まれます — すべて `/v1` の下にあります。追加的な変更はバージョンを上げずに提供し、既存の連携を壊す変更には移行期間を伴う新バージョンを設けます。パスポートのレコード自体は別途バージョン管理されます。パスポートは、それが作成された API バージョンより長く存続するからです。