Naar de inhoud

Paspoorten openbaar opvragen

Paspoorten openbaar opvragen

Iedereen kan een gepubliceerd paspoort lezen met deze drie methoden. Ze hebben geen API-sleutel nodig. Ze gebruiken de paden van EN 18222, de Europese norm voor paspoort-API's.

Basisadres

Elke methode begint bij https://passportcraft.com. Het eigen paspoortdomein van een merk beantwoordt dezelfde methoden voor de paspoorten van dat merk.

Vraagt een register om het API-eindpunt van een paspoort (dppApiEndpoint in EN 18222), geef dan dit basisadres op.

https://passportcraft.com

Methoden

  • GET/v1/dpps/{dppId}

    Eén paspoort lezen op basis van zijn id.

  • GET/v1/dppsByProductId/{productId}

    Het paspoort van één product lezen.

  • POST/v1/dppsByProductIds

    De paspoort-id's van meerdere producten opzoeken.

Verzoek
curl "https://passportcraft.com/v1/dpps/https%3A%2F%2Fpassportcraft.com%2Fpassport%2F{id}"
Antwoord
{
  "digitalProductPassportId": "https://passportcraft.com/passport/{id}",
  "uniqueProductIdentifier": "https://passportcraft.com/01/{gtin}",
  "granularity": "model",
  "dppSchemaVersion": "EN18223:v1.0",
  "dppStatus": "active",
  "lastUpdated": "2026-01-01T00:00:00Z"
}

Identificatoren

dppId is de digitalProductPassportId van het paspoort, percent-gecodeerd. Alleen de id van het paspoort werkt ook.

productId is de uniqueProductIdentifier van het paspoort, percent-gecodeerd. Dat is zijn GS1 Digital Link, of het paspoortadres als het product geen barcode heeft.

Stuur maximaal 500 productidentificatoren als JSON-array in het verzoeklichaam. Stuur elke identificator precies zoals het paspoort hem geeft. Voeg niet de percent-codering toe die de twee GET-methoden nodig hebben. Het antwoord noemt de gevonden paspoort-id's in de volgorde waarin u ze hebt verstuurd. Een productidentificator die bij geen enkel gepubliceerd paspoort past, wordt weggelaten.

limit bepaalt hoeveel productidentificatoren een pagina leest, van 1 tot 100. Zonder limit leest een pagina er 50. Zolang er meer zijn, bevat paging_metadata.cursor de waarde die u als cursor meestuurt voor de volgende pagina.

Weergave

Het paspoort komt standaard in de gecomprimeerde vorm. Voeg ?representation=full toe voor de volledige vorm, die het type van elk element noemt.

Browsers

Een verzoek dat HTML verkiest, zoals dat van een browser, wordt doorgestuurd naar de paspoortpagina.

Statuscodes

200Het paspoort, of de lijst met paspoort-id's.
303Een doorverwijzing naar de paspoortpagina, voor een browser.
400De id, de productidentificator, het verzoeklichaam of een waarde in de query is ongeldig.
404Geen gepubliceerd paspoort komt overeen.
405Dit pad accepteert deze methode niet.
500Het paspoort kon nu niet worden gelezen. Probeer het zo meteen opnieuw.
501EN 18222 definieert deze methode en wij bieden die niet aan.

Elke fout behalve 501 bevat een result-object. Het bevat een lijst met berichten, elk met messageType, text, code en timestamp. Programma's moeten code lezen, want die verandert nooit.

Deze methoden lezen alleen. Gebruik de geauthenticeerde API om paspoorten aan te maken of te wijzigen.