CirculeID

Developers

Paspoorten, gebeurtenissen en credentials — via HTTP

Geef een paspoort uit, voeg een EPCIS 2.0-gebeurtenis toe of verifieer het credential van een leverancier vanuit de systemen die u al draait. Open standaarden over de lijn, zodat niets wat u hier bouwt vastzit.

De documentatie lezenAPI-referentie
Identiteit
GS1 Digital Link
Gebeurtenissen
EPCIS 2.0
Claims
W3C VC 2.0

Definition

Hoe geeft u een digitaal productpaspoort uit via een API?

Maak een paspoortresource aan op een GS1-identificator, koppel het productrecord, voeg EPCIS 2.0-gebeurtenissen toe terwijl het item beweegt, en geef W3C Verifiable Credentials uit voor claims die bewijsbaar moeten zijn. Lezen resolvet de identificator en geeft de weergave terug waar de credentials van de aanroeper recht op geven.

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

Snelstart

Een paspoort uitgeven in één request

Post een productrecord op een GS1-identificator. Het antwoord bevat de resolvebare Digital Link en de dragerpayload die u drukt of codeert.
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.

Integratiepad

Van API-sleutel naar een resolvebaar paspoort

Vier stappen. Het meeste werk zit in stap één, en dat is mappen in plaats van bouwen.
  1. 01

    Authenticeren

    Maak een API-sleutel met scope aan. Sleutels zijn begrensd per omgeving en per functie, zodat een uitgiftedienst nooit leestoegang tot commerciële data heeft.

  2. 02

    Het productrecord in kaart brengen

    Post uw bestaande productmaster op de bijbehorende GS1-identificator. De API meldt welke velden de productgroep onder haar gedelegeerde handeling nog vereist.

  3. 03

    Gebeurtenissen en credentials toevoegen

    Schrijf EPCIS 2.0-gebeurtenissen terwijl het artikel beweegt, en geef verifieerbare credentials uit voor claims die onafhankelijke toetsing moeten doorstaan.

  4. 04

    Resolven en abonneren

    De Digital Link-identificator resolvet naar de voor de aanroeper passende weergave. Webhooks waarschuwen uw systemen wanneer een paspoort, gebeurtenis of credential verandert.

Developers · 01

Bouwen

Van API-sleutel naar uitgegeven paspoort.

Developers · 02

Beheren

Een integratie in productie draaien.

Antwoorden

Veelgestelde vragen

Wat geeft de CirculeID-API werkelijk uit?

Een paspoortresource met een GS1 Digital Link-identificator, een set daaraan gekoppelde EPCIS 2.0-gebeurtenissen, en W3C Verifiable Credentials met de claims die bewijsbaar moeten zijn. Een paspoort lezen betekent de identificator resolven en de weergave teruggeven waar de aanroeper recht op heeft, afhankelijk van de getoonde credentials.

Moeten wij onze productdata naar CirculeID migreren?

Nee. CirculeID staat boven uw ERP, PLM en koolstofboekhouding in plaats van ze te vervangen. Data stroomt binnen via de REST-API en webhooks, en het paspoort wordt een weergave over systemen die u al draait. De meeste integraties beginnen met het mappen van een bestaand productmaster, niet met het importeren ervan.

Hoe wordt paspoortdata tussen systemen geauthenticeerd?

Machine-naar-machinetoegang gebruikt API-sleutels met scope. Claims binnen een paspoort worden door de uitgevende partij ondertekend als W3C Verifiable Credentials, met een Decentralized Identifier die onafhankelijk van CirculeID resolvet — een stroomafwaarts systeem kan een leveranciersclaim dus verifiëren zonder ons ook maar aan te roepen.

Wat gebeurt er met onze paspoorten als wij stoppen met CirculeID?

Paspoorten zijn uitgedrukt in gepubliceerde standaarden, zodat het record ook buiten ons platform betekenisvol blijft. Identificatoren volgen GS1 Digital Link, gebeurtenissen EPCIS 2.0, credentials W3C Verifiable Credentials 2.0, en het veldmodel volgt CIRPASS. Export geeft u dezelfde documenten die een andere conforme resolver kan serveren.

Next step

Bouw tegen het paspoort, niet tegen een leverancier

Haal een API-sleutel op, geef een paspoort uit op een van uw eigen GTIN’s, en zie wat er resolvet.

De documentatie lezenSpreek een engineer

Index

Verwante artikelen