Verificação pública

Estes endpoints são públicos e não requerem autenticação. Permitem a qualquer pessoa verificar credenciais de distintivos e obter dados JSON Open Badge v2.0.

Todos os endpoints são relativos a https://api.badges.ninja.

Obter emissor

Obtenha o JSON do Open Badge v2.0 Issuer Profile para um determinado emissor.

GET /certify-badge/issuer/{guid}

Exemplo

curl https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-e5f6-7890-abcd-ef1234567890

Resposta

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "Issuer",
  "id": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
  "name": "Acme Academy",
  "url": "https://acme.example.com",
  "email": "badges@acme.example.com",
  "verification": {
    "type": "hosted",
    "allowedOrigins": "api.badges.ninja"
  }
}

---

Obter distintivo

Obtenha o JSON do Open Badge v2.0 BadgeClass para um determinado distintivo.

GET /certify-badge/badge/{guid}

Exemplo

curl https://api.badges.ninja/certify-badge/badge/b1c2d3e4-f5a6-7890-bcde-f12345678901

Resposta

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "BadgeClass",
  "id": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
  "name": "JavaScript Fundamentals",
  "description": "Demonstrates proficiency in core JavaScript concepts",
  "criteria": {
    "narrative": "Completed the JavaScript Fundamentals course with a score of 80% or higher"
  },
  "image": "https://ipfs.ninja/ipfs/Qm...",
  "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-..."
}

---

Obter atribuição

Obtenha o JSON do Open Badge v2.0 Assertion para uma determinada atribuição.

GET /certify-badge/award/{guid}

Exemplo

curl https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012

Resposta

{
  "@context": "https://w3id.org/openbadges/v2",
  "type": "Assertion",
  "id": "https://api.badges.ninja/certify-badge/award/c1d2e3f4-...",
  "recipient": {
    "type": "email",
    "hashed": true,
    "identity": "sha256$..."
  },
  "badge": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
  "issuedOn": "2025-01-15T00:00:00.000Z",
  "verification": {
    "type": "hosted"
  }
}

Notas

• O e-mail do destinatário é representado por um hash (SHA-256) para assegurar a privacidade, conforme a especificação Open Badge.
• As respostas são colocadas em cache durante 1 hora (Cache-Control: public, max-age=3600).

---

Obter texto de partilha da atribuição

Obtenha o texto de partilha personalizado do distintivo de uma atribuição.

GET /certify-badge/award/{guid}/share-text

Exemplo

curl https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012/share-text

Resposta

{
  "text": "I just earned the JavaScript Fundamentals badge! Check it out:"
}

Se não estiver definido um texto de partilha personalizado, é devolvida uma mensagem predefinida.

---

Enviar e-mail de atribuição (público)

Envia um e-mail de notificação de atribuição a partir do endpoint público. É usado pela página pública de partilha.

POST /certify-badge/award/{guid}/send-email

Parâmetros

Parâmetro	Tipo	Obrigatório	Descrição
recipients	string	Sim	Lista de endereços de e-mail separados por vírgulas
subject	string	Não	Assunto do e-mail
message	string	Não	Mensagem personalizada a incluir no e-mail

Exemplo

curl -X POST https://api.badges.ninja/certify-badge/award/c1d2e3f4-a5b6-7890-cdef-123456789012/send-email \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "recipients": "colleague@example.com",
      "message": "Check out this badge!"
    }
  }'

Resposta

{
  "statusCode": 200,
  "info": "award sent"
}

---

Verificar emissor

Verifica um emissor clicando na ligação de verificação enviada para o seu e-mail. Normalmente é acedido através da ligação no e-mail de verificação e não chamado directamente.

GET /certify-badge/verify-issuer/{guid}/{code}

Parâmetros

Parâmetro	Tipo	Descrição
guid	string	O GUID do emissor
code	string	O código de verificação

Resposta

Devolve uma página HTML a confirmar que a verificação teve sucesso ou falhou. Este endpoint destina-se a ser aberto num navegador.