Documentation
Comece aqui
Tudo o que precisa para emitir um passaporte, acrescentar eventos da cadeia e verificar uma credencial — com as normas em que cada um assenta, para que nada do que construir fique preso a esta plataforma.
- Protocolo
- JSON sobre HTTPS
- Eventos
- EPCIS 2.0 JSON-LD
- Credenciais
- 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 com o registo do produto, acrescente eventos EPCIS 2.0 à medida que o produto 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 formats are not ours: GS1 Digital Link for identity, EPCIS 2.0 for events, and W3C Verifiable Credentials for claims.
Início rápido
O seu primeiro passaporte
curl https://api.circuleid.com/v1/passports \
-H "Authorization: Bearer $CIRCULEID_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"gtin": "09506000134352",
"productGroup": "textiles",
"level": "model",
"record": {
"name": "Merino Crew Knit",
"materials": [
{ "name": "merino wool", "share": 0.82, "certification": "RWS" },
{ "name": "recycled polyamide", "share": 0.18 }
]
}
}'Illustrative request shape. The API reference carries the authoritative schema and error contract.
Referência
Para onde ir a seguir
Autenticação
Chaves de API, âmbitos e acesso máquina a máquina.
Visão geral da API
Como se relacionam as API de passaporte, evento e credencial.
Referência da API
Cada endpoint, parâmetro e formato de resposta.
SDK
Clientes tipados que espelham o contrato da API.
Exemplos
Integrações funcionais que pode ler de ponta a ponta.
Webhooks
Reagir a alterações de passaportes, eventos e credenciais.
Limites de taxa
Quotas, comportamento em rajada e orientações de recuo.
Normas
As especificações a que cada carga útil obedece.
Percurso de integração
Da chave de API a um passaporte resolúvel
- 01
Obter uma chave com âmbito
As chaves são delimitadas por ambiente e por capacidade, pelo que um serviço de emissão nunca tem acesso de leitura a dados restritos.
- 02
Mapear o registo de produto
Publique o seu mestre de produto sobre o respetivo identificador GS1. A resposta identifica os campos que o grupo de produtos ainda exige.
- 03
Acrescentar eventos e credenciais
Escreva eventos EPCIS 2.0 à medida que o artigo se move; emita credenciais para as alegações que têm de resistir a escrutínio independente.
- 04
Resolver e subscrever
O identificador resolve para a vista adequada a quem chama, e os webhooks avisam os seus sistemas assim que algo muda.
Respostas
Perguntas frequentes
De que preciso antes de poder emitir um passaporte?
Uma chave de API, um identificador GS1 para o produto e o próprio registo de produto. Se ainda não tiver identificadores GS1, essa é a primeira dependência a resolver: vêm da sua organização membro GS1, não de nós, porque a identidade tem de ser globalmente única fora da nossa plataforma.
Existe uma sandbox?
Sim. As chaves têm âmbito por ambiente, pelo que as chaves de sandbox não conseguem tocar em passaportes de produção e as de produção não podem ser usadas por engano num banco de testes. Os passaportes de sandbox resolvem exatamente como os de produção, contra um nome de anfitrião de resolvedor separado.
Quais são os formatos de transporte?
JSON sobre HTTPS para a API. Os eventos seguem a serialização JSON-LD do GS1 EPCIS 2.0, e as credenciais o modelo de dados W3C Verifiable Credentials 2.0. Onde uma norma define uma representação, usamo-la em vez de inventar uma, o que significa que as ferramentas existentes para essas normas funcionam com o nosso resultado.
Como devem ser tratados os erros?
A API devolve códigos de estado HTTP convencionais com um corpo de erro estruturado que identifica o campo e a restrição não cumprida. Os erros de validação são devolvidos por inteiro em vez de um de cada vez, pelo que um registo malformado revela todos os problemas numa resposta em vez de em cinco idas e voltas.
Como obtemos apoio durante a integração?
Pelo canal de apoio associado à sua conta, ou pela via de contacto se ainda estiver em avaliação. As perguntas de integração que revelam uma lacuna na documentação são tratadas como defeitos de documentação, que é a única forma de uma referência se manter exata à medida que a API cresce.
Next step
Emitir um passaporte sobre o seu próprio GTIN
Obtenha uma chave de sandbox, envie um registo de produto e veja o que o suporte devolvido resolve.