CirculeID

Developers

Passaporti, eventi e credenziali — su HTTP

Emetti un passaporto, aggiungi un evento EPCIS 2.0 o verifica la credenziale di un fornitore dai sistemi che già utilizzi. Standard aperti sul filo, così nulla di ciò che costruisci qui resta prigioniero.

Leggi la documentazioneRiferimento API
Identità
GS1 Digital Link
Eventi
EPCIS 2.0
Dichiarazioni
W3C VC 2.0

Definition

Come si emette un passaporto digitale di prodotto tramite un’API?

Crea una risorsa passaporto su un identificativo GS1, collega il record di prodotto, aggiungi eventi EPCIS 2.0 man mano che l’oggetto si muove, ed emetti W3C Verifiable Credentials per le dichiarazioni che devono essere dimostrabili. La lettura risolve l’identificativo e restituisce la vista cui le credenziali del chiamante danno diritto.

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

Guida rapida

Emettere un passaporto in una sola richiesta

Invia un record di prodotto su un identificativo GS1. La risposta porta il Digital Link risolvibile e il payload del supporto che stampi o codifichi.
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.

Percorso di integrazione

Dalla chiave API a un passaporto risolvibile

Quattro passaggi. Gran parte dello sforzo è nel primo, ed è mappatura anziché costruzione.
  1. 01

    Autenticare

    Crea una chiave API con ambito. Le chiavi sono delimitate per ambiente e per funzionalità, così un servizio di emissione non ha mai accesso in lettura ai dati commerciali.

  2. 02

    Mappare il record di prodotto

    Invia la tua anagrafica di prodotto esistente sul suo identificativo GS1. L’API segnala quali campi il gruppo di prodotti richiede ancora ai sensi del suo atto delegato.

  3. 03

    Aggiungere eventi e credenziali

    Scrivete eventi EPCIS 2.0 mentre l’articolo si muove, ed emettete credenziali verificabili per le asserzioni che devono reggere a un esame indipendente.

  4. 04

    Risolvere e sottoscrivere

    L’identificativo Digital Link si risolve alla vista adatta al chiamante. I webhook avvisano i tuoi sistemi quando un passaporto, un evento o una credenziale cambia.

Developers · 01

Costruire

Dalla chiave API al passaporto emesso.

Developers · 02

Operare

Gestire un’integrazione in produzione.

Risposte

Domande frequenti

Che cosa emette davvero l’API di CirculeID?

Una risorsa passaporto con un identificativo GS1 Digital Link, un insieme di eventi EPCIS 2.0 a essa collegati e W3C Verifiable Credentials che portano le dichiarazioni da provare. Leggere un passaporto significa risolvere l’identificativo e restituire la vista cui il chiamante ha diritto, che dipende dalle credenziali presentate.

Dobbiamo migrare i nostri dati di prodotto in CirculeID?

No. CirculeID si colloca sopra il tuo ERP, PLM e sistema di contabilità del carbonio anziché sostituirli. I dati entrano dall’API REST e dai webhook, e il passaporto diventa una vista sui sistemi che già utilizzi. Gran parte delle integrazioni parte mappando un’anagrafica di prodotto esistente anziché importarne una.

Come sono autenticati i dati del passaporto tra sistemi?

L’accesso machine-to-machine usa chiavi API con ambito. Le dichiarazioni all’interno di un passaporto sono firmate dalla parte emittente come W3C Verifiable Credentials, con un Decentralized Identifier che si risolve indipendentemente da CirculeID: un sistema a valle può quindi verificare la dichiarazione di un fornitore senza chiamarci affatto.

Che cosa succede ai nostri passaporti se smettiamo di usare CirculeID?

I passaporti sono espressi in standard pubblicati, così il record resta significativo fuori dalla nostra piattaforma. Gli identificativi seguono GS1 Digital Link, gli eventi EPCIS 2.0, le credenziali W3C Verifiable Credentials 2.0, e il modello dei campi segue CIRPASS. L’export ti dà gli stessi documenti che un altro resolver conforme può servire.

Next step

Sviluppa verso il passaporto, non verso un fornitore

Ottieni una chiave API, emetti un passaporto su uno dei tuoi GTIN e osserva che cosa si risolve.

Leggi la documentazioneParla con un ingegnere

Index

Letture correlate