CirculeID

Developers

Passeports, événements et attestations — en HTTP

Émettez un passeport, ajoutez un événement EPCIS 2.0 ou vérifiez l’attestation d’un fournisseur depuis les systèmes que vous exploitez déjà. Des standards ouverts sur le fil, si bien que rien de ce que vous construisez ici n’est captif.

Lire la documentationRéférence de l’API
Identité
GS1 Digital Link
Événements
EPCIS 2.0
Déclarations
W3C VC 2.0

Definition

Comment émettre un passeport numérique de produit via une API ?

Créez une ressource passeport sur un identifiant GS1, rattachez l’enregistrement produit, ajoutez des événements EPCIS 2.0 au fil des mouvements, et émettez des W3C Verifiable Credentials pour les déclarations à prouver. La lecture résout l’identifiant et renvoie la vue à laquelle les attestations de l’appelant donnent droit.

The wire format is not ours. Identity follows GS1 Digital Link, events follow EPCIS 2.0, and claims follow W3C Verifiable Credentials 2.0.

Démarrage rapide

Émettre un passeport en une requête

Publiez un enregistrement produit sur un identifiant GS1. La réponse porte le Digital Link résolvable et la charge utile de support que vous imprimez ou encodez.
POST /v1/passports
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.

Parcours d’intégration

De la clé d’API à un passeport résolvable

Quatre étapes. L’essentiel de l’effort est à l’étape une, et c’est du mapping, pas de la construction.
  1. 01

    Authentifier

    Créez une clé d’API à portée limitée. Les clés sont limitées par environnement et par capacité, si bien qu’un service d’émission ne détient jamais d’accès en lecture aux données commerciales.

  2. 02

    Cartographier l’enregistrement produit

    Publiez votre référentiel produit existant sur son identifiant GS1. L’API signale les champs que le groupe de produits exige encore au titre de son acte délégué.

  3. 03

    Ajouter événements et attestations

    Écrivez des événements EPCIS 2.0 à mesure que l’article circule, et émettez des certificats vérifiables pour les allégations qui doivent résister à un examen indépendant.

  4. 04

    Résoudre et s’abonner

    L’identifiant Digital Link se résout vers la vue adaptée à l’appelant. Les webhooks préviennent vos systèmes quand un passeport, un événement ou une attestation change.

Developers · 01

Construire

De la clé d’API au passeport émis.

Developers · 02

Exploiter

Faire tourner une intégration en production.

Réponses

Questions fréquentes

Qu’émet réellement l’API CirculeID ?

Une ressource passeport dotée d’un identifiant GS1 Digital Link, d’un ensemble d’événements EPCIS 2.0 qui s’y rattachent, et de W3C Verifiable Credentials portant les déclarations à prouver. Lire un passeport revient à résoudre l’identifiant et à renvoyer la vue à laquelle l’appelant a droit, ce qui dépend des attestations présentées.

Devons-nous migrer nos données produit dans CirculeID ?

Non. CirculeID se place au-dessus de vos ERP, PLM et comptabilité carbone plutôt que de les remplacer. La donnée arrive par l’API REST et les webhooks, et le passeport devient une vue sur des systèmes que vous exploitez déjà. La plupart des intégrations commencent par cartographier un référentiel produit existant plutôt que par en importer un.

Comment les données de passeport sont-elles authentifiées entre systèmes ?

L’accès machine-à-machine utilise des clés d’API à portée limitée. Les déclarations d’un passeport sont signées en W3C Verifiable Credentials par la partie émettrice, avec un Decentralized Identifier qui se résout indépendamment de CirculeID — un système aval peut donc vérifier une déclaration fournisseur sans nous appeler du tout.

Qu’advient-il de nos passeports si nous cessons d’utiliser CirculeID ?

Les passeports sont exprimés dans des standards publiés, si bien que l’enregistrement reste significatif hors de notre plateforme. Les identifiants suivent GS1 Digital Link, les événements EPCIS 2.0, les attestations W3C Verifiable Credentials 2.0, et le modèle de champs suit CIRPASS. L’export vous donne les mêmes documents qu’un autre résolveur conforme peut servir.

Next step

Développez contre le passeport, pas contre un fournisseur

Obtenez une clé d’API, émettez un passeport sur l’un de vos propres GTIN, et voyez ce qui se résout.

Lire la documentationParler à un ingénieur

Index

À lire également