Разработчикам · Документация
Документация и API
Официальные спецификации, JSON-LD контексты и примеры запросов. Всё ведёт на первоисточники.
Эта страница — навигатор по первоисточникам. Сам стандарт не предоставляет единого «облачного API»: каждый эмитент публикует свои данные сам. Ниже — спецификации, контексты и практические примеры, как читать и проверять бейджи.
JSON-LD контексты
- OB 2.0 context
- https://w3id.org/openbadges/v2 — JSON-LD контекст для assertion, BadgeClass и Profile.
- OB 3.0 context
- https://purl.imsglobal.org/spec/ob/v3p0/context.json — поверх VC Data Model.
- VC context
- https://www.w3.org/ns/credentials/v2 — базовый контекст Verifiable Credentials.
Пример: чтение hosted-бейджа
Как дочитать цепочку assertion → BadgeClass → Profile.
// Прочитать hosted-бейдж 2.0 и показать ключевые поля
const res = await fetch(assertionUrl, {
headers: { Accept: 'application/json' },
});
const assertion = await res.json();
// assertion.badge — ссылка на BadgeClass; дочитываем его
const badge = await (await fetch(assertion.badge)).json();
const issuer = await (await fetch(badge.issuer)).json();
console.log({
achievement: badge.name,
issuer: issuer.name,
issuedOn: assertion.issuedOn,
verification: assertion.verification?.type,
});Инструменты
- JSON-LD процессоры (jsonld.js и аналоги) — для нормализации контекстов.
- Библиотеки Verifiable Credentials — для выпуска и проверки подписи в 3.0.
- Валидаторы по JSON Schema — для проверки структуры assertion и BadgeClass.
Хотите увидеть проверку в действии?
Валидатор на сайте делает ровно это — читает бейдж и показывает его поля прямо в браузере.