Developers
Pasaportes, eventos y credenciales, sobre HTTP
Emita un pasaporte, añada un evento EPCIS 2.0 o verifique la credencial de un proveedor desde los sistemas que ya utiliza. Estándares abiertos en el cable, de modo que nada de lo que construya aquí queda cautivo.
- Identidad
- GS1 Digital Link
- Eventos
- EPCIS 2.0
- Declaraciones
- W3C VC 2.0
Definition
¿Cómo se emite un pasaporte digital de producto mediante una API?
Cree un recurso de pasaporte sobre un identificador GS1, adjunte el registro de producto, añada eventos EPCIS 2.0 conforme el artículo se mueve, y emita W3C Verifiable Credentials para las declaraciones que deban ser demostrables. La lectura resuelve el identificador y devuelve la vista a la que dan derecho las credenciales del llamante.
The wire format is not ours. Identity follows GS1 Digital Link, events follow EPCIS 2.0, and claims follow W3C Verifiable Credentials 2.0.
Inicio rápido
Emitir un pasaporte en una sola petición
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.
Ruta de integración
De la clave de API a un pasaporte resoluble
- 01
Autenticar
Cree una clave de API acotada. Las claves se acotan por entorno y por capacidad, de modo que un servicio de emisión nunca tiene acceso de lectura a datos comerciales.
- 02
Mapear el registro de producto
Envíe su maestro de producto existente contra su identificador GS1. La API informa de qué campos sigue exigiendo el grupo de productos según su acto delegado.
- 03
Añadir eventos y credenciales
Escriba eventos EPCIS 2.0 a medida que el artículo se mueve, y emita credenciales verificables para las afirmaciones que deban resistir un escrutinio independiente.
- 04
Resolver y suscribirse
El identificador Digital Link resuelve a la vista adecuada al llamante. Los webhooks avisan a sus sistemas cuando cambia un pasaporte, un evento o una credencial.
Developers · 01
Construir
Documentación
Conceptos, guías rápidas y el modelo de datos.
Visión general de la API
Cómo encajan las API de pasaporte, evento y credencial.
Referencia de la API
Cada endpoint, parámetro y forma de respuesta.
SDK
Bibliotecas cliente para los lenguajes de su stack.
Ejemplos
Integraciones funcionales que puede leer de principio a fin.
Developers · 02
Operar
Respuestas
Preguntas frecuentes
¿Qué emite realmente la API de CirculeID?
Un recurso de pasaporte con un identificador GS1 Digital Link, un conjunto de eventos EPCIS 2.0 adjuntos y W3C Verifiable Credentials que portan las declaraciones que deben ser demostrables. Leer un pasaporte consiste en resolver el identificador y devolver la vista a la que el llamante tiene derecho, que depende de las credenciales presentadas.
¿Tenemos que migrar nuestros datos de producto a CirculeID?
No. CirculeID se sitúa por encima de su ERP, PLM y contabilidad de carbono en vez de sustituirlos. Los datos entran por la API REST y los webhooks, y el pasaporte pasa a ser una vista sobre sistemas que ya utiliza. La mayoría de integraciones empiezan mapeando un maestro de producto existente en lugar de importar uno.
¿Cómo se autentican los datos del pasaporte entre sistemas?
El acceso máquina a máquina usa claves de API acotadas. Las declaraciones dentro de un pasaporte las firma la parte emisora como W3C Verifiable Credentials, con un Decentralized Identifier que se resuelve con independencia de CirculeID, de modo que un sistema posterior puede verificar la declaración de un proveedor sin llamarnos en absoluto.
¿Qué pasa con nuestros pasaportes si dejamos de usar CirculeID?
Los pasaportes se expresan en estándares publicados, de modo que el registro sigue siendo significativo fuera de nuestra plataforma. Los identificadores siguen GS1 Digital Link, los eventos EPCIS 2.0, las credenciales W3C Verifiable Credentials 2.0, y el modelo de campos sigue CIRPASS. La exportación le da los mismos documentos que otro resolutor conforme puede servir.
Next step
Construya contra el pasaporte, no contra un proveedor
Obtenga una clave de API, emita un pasaporte contra uno de sus propios GTIN y vea qué se resuelve.