CirculeID

Developers

Passaportes, eventos e credenciais — por HTTP

Emita um passaporte, acrescente um evento EPCIS 2.0 ou verifique a credencial de um fornecedor a partir dos sistemas que já utiliza. Normas abertas na comunicação, para que nada do que aqui construir fique preso.

Ler a documentaçãoReferência da API
Identidade
GS1 Digital Link
Eventos
EPCIS 2.0
Declarações
W3C VC 2.0

Definition

Como se emite um passaporte digital de produto através de uma API?

Crie um recurso de passaporte sobre um identificador GS1, anexe o registo do produto, acrescente eventos EPCIS 2.0 à medida que o artigo se move, e emita W3C Verifiable Credentials para as declarações que têm de ser prováveis. A leitura resolve o identificador e devolve a vista a que as credenciais de quem chama dão direito.

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

Início rápido

Emitir um passaporte num único pedido

Publique um registo de produto sobre um identificador GS1. A resposta traz o Digital Link resolúvel e a carga útil do suporte que imprime ou codifica.
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.

Percurso de integração

Da chave de API a um passaporte resolúvel

Quatro passos. A maior parte do esforço está no primeiro, e é mapear em vez de construir.
  1. 01

    Autenticar

    Crie uma chave de API com âmbito. As chaves são delimitadas por ambiente e por capacidade, pelo que um serviço de emissão nunca detém acesso de leitura a dados comerciais.

  2. 02

    Mapear o registo de produto

    Publique o seu mestre de produto existente sobre o respetivo identificador GS1. A API indica que campos o grupo de produtos ainda exige ao abrigo do seu ato delegado.

  3. 03

    Acrescentar eventos e credenciais

    Escreva eventos EPCIS 2.0 à medida que o artigo se move, e emita credenciais verificáveis para as alegações que têm de resistir a escrutínio independente.

  4. 04

    Resolver e subscrever

    O identificador Digital Link resolve para a vista adequada a quem chama. Os webhooks avisam os seus sistemas quando um passaporte, evento ou credencial muda.

Developers · 01

Construir

Da chave de API ao passaporte emitido.

Developers · 02

Operar

Manter uma integração em produção.

Respostas

Perguntas frequentes

O que emite realmente a API da CirculeID?

Um recurso de passaporte com um identificador GS1 Digital Link, um conjunto de eventos EPCIS 2.0 a ele associados e W3C Verifiable Credentials com as declarações que têm de ser prováveis. Ler um passaporte é resolver o identificador e devolver a vista a que quem chama tem direito, o que depende das credenciais apresentadas.

Temos de migrar os nossos dados de produto para a CirculeID?

Não. A CirculeID situa-se acima do seu ERP, PLM e sistema de contabilidade de carbono em vez de os substituir. Os dados entram pela API REST e pelos webhooks, e o passaporte torna-se uma vista sobre sistemas que já utiliza. A maioria das integrações começa por mapear um mestre de produto existente, e não por importar um.

Como são autenticados os dados do passaporte entre sistemas?

O acesso máquina a máquina usa chaves de API com âmbito. As declarações dentro de um passaporte são assinadas pela parte emissora como W3C Verifiable Credentials, com um Decentralized Identifier que se resolve independentemente da CirculeID — um sistema a jusante pode assim verificar a declaração de um fornecedor sem nos contactar sequer.

O que acontece aos nossos passaportes se deixarmos de usar a CirculeID?

Os passaportes são expressos em normas publicadas, pelo que o registo permanece significativo fora da nossa plataforma. Os identificadores seguem o GS1 Digital Link, os eventos o EPCIS 2.0, as credenciais as W3C Verifiable Credentials 2.0, e o modelo de campos segue o CIRPASS. A exportação dá-lhe os mesmos documentos que outro resolvedor conforme pode servir.

Next step

Desenvolva contra o passaporte, não contra um fornecedor

Obtenha uma chave de API, emita um passaporte sobre um dos seus próprios GTIN e veja o que se resolve.

Ler a documentaçãoFalar com um engenheiro

Index

Leituras relacionadas