Definition
API経由でデジタル製品パスポートをどう発行しますか。
GS1識別子に対してパスポートリソースを作成し、製品レコードを紐づけ、対象物の移動に応じてEPCIS 2.0イベントを追加し、証明が必要な主張についてW3C Verifiable Credentialsを発行します。読み取りは識別子を解決し、呼び出し元のクレデンシャルが認めるビューを返します。
The wire format is not ours. Identity follows GS1 Digital Link, events follow EPCIS 2.0, and claims follow W3C Verifiable Credentials 2.0.
クイックスタート
一回のリクエストでパスポートを発行する
curl https://api.circuleid.com/v1/passports \
-H "Authorization: Bearer $CIRCULEID_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"gtin": "09506000134352",
"productGroup": "textiles",
"record": {
"name": "Merino Crew Knit",
"materials": [
{ "name": "merino wool", "share": 0.82, "certification": "RWS" },
{ "name": "recycled polyamide", "share": 0.18 }
],
"carbonFootprint": { "value": 14.2, "unit": "kgCO2e", "method": "ISO 14067" }
}
}'Illustrative request shape. See the API reference for the authoritative schema and error contract.
連携の進め方
APIキーから、解決可能なパスポートへ
- 01
認証する
スコープ付きのAPIキーを作成します。キーは環境ごと、機能ごとに限定されるため、発行サービスが商業データへの読み取り権限を持つことはありません。
- 02
製品レコードを対応づける
既存の製品マスターをそのGS1識別子に対して送信してください。APIが、当該製品グループの委任法令のもとでまだ必要な項目を報告します。
- 03
イベントとクレデンシャルを追加する
品物の移動に合わせて EPCIS 2.0 イベントを書き込み、独立した検証に耐える必要のある主張には検証可能クレデンシャルを発行します。
- 04
解決して購読する
Digital Link 識別子は呼び出し元に応じたビューに解決されます。Webhook は、パスポート・イベント・クレデンシャルが変化した際に貴社のシステムへ通知します。
Developers · 02
運用
回答
よくある質問
CirculeID の API は実際に何を発行するのですか。
GS1 Digital Linkの識別子を持つパスポートリソースと、それに紐づくEPCIS 2.0イベント群、そして証明が必要な主張を担うW3C Verifiable Credentialsです。パスポートを読むとは、識別子を解決し、提示されたクレデンシャルに応じて呼び出し元が権限を持つビューを返すことを意味します。
製品データをCirculeIDへ移行する必要がありますか。
いいえ。CirculeIDはERP、PLM、カーボン会計を置き換えるのではなく、その上に載ります。データはREST APIとWebhookで流れ込み、パスポートはすでに稼働中のシステムに対するビューになります。多くの連携は、製品マスターを取り込むのではなく、既存の製品マスターを対応づけることから始まります。
パスポートのデータはシステム間でどう認証されますか。
マシン間アクセスにはスコープ付きのAPIキーを用います。パスポート内の主張は発行者がW3C Verifiable Credentialsとして署名し、CirculeIDとは独立に解決されるDecentralized Identifierを使います。したがって下流のシステムは、当社をまったく呼び出さずにサプライヤーの主張を検証できます。
CirculeID の利用をやめた場合、当社のパスポートはどうなりますか。
パスポートは公開された標準で表現されるため、当社のプラットフォームの外でもレコードは意味を保ちます。識別子はGS1 Digital Link、イベントはEPCIS 2.0、クレデンシャルはW3C Verifiable Credentials 2.0、項目モデルはCIRPASSに従います。エクスポートでは、適合する別のリゾルバがそのまま提供できる同一の文書が得られます。