API-ul credențialelor

Gestionează șabloanele de credențiale — cele pe care le livrezi destinatarilor.

Toate endpoint-urile necesită autentificare prin antetul X-Api-Key. Consultă Autentificare.

Creează credențială

Creează o credențială nouă sub un emitent verificat.

POST /badges

Parametri

Parametru	Tip	Obligatoriu	Descriere
name	string	Da	Titlul credențialei
description	string	Da	Ce reprezintă credențiala
criteria	string	Da	Ce a făcut destinatarul pentru a o obține
image	string	Da	Imagine codificată în Base64 (PNG sau JPG)
issuerId	string	Da	ID-ul emitentului verificat

Exemplu

curl -X POST https://api.badges.ninja/badges \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "JavaScript Fundamentals",
      "description": "Demonstrates proficiency in core JavaScript concepts",
      "criteria": "Completed the JavaScript Fundamentals course with a score of 80% or higher",
      "image": "data:image/png;base64,iVBORw0KGgo...",
      "issuerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  }'

Răspuns

{
  "statusCode": 200,
  "info": {
    "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-f5a6-7890-bcde-f12345678901"
  }
}

Note

• Emitentul trebuie să fie verificat înainte de a crea credențiale.
• Imaginea este încărcată pe IPFS pentru stocare durabilă.

---

Listează credențialele

Recuperează toate credențialele pe care le-ai creat.

GET /badges

Exemplu

curl -X GET https://api.badges.ninja/badges \
  -H "X-Api-Key: bws_your_api_key_here"

Răspuns

{
  "statusCode": 200,
  "info": {
    "badges": [
      {
        "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..." },
        "image": "https://ipfs.ninja/ipfs/Qm...",
        "issuer": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
        "timestamp": "2025-01-15T10:30:00.000Z"
      }
    ]
  }
}

---

Actualizează credențială

Actualizează o credențială existentă. Se modifică doar câmpurile pe care le trimiți.

PUT /badges/{badgeId}

Parametri

Parametru	Tip	Obligatoriu	Descriere
badgeId	string	Da	ID-ul credențialei (parametru de rută)
name	string	Nu	Titlu nou
description	string	Nu	Descriere nouă
criteria	string	Nu	Criterii noi
image	string	Nu	Imagine nouă în Base64

Exemplu

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "name": "JavaScript Fundamentals v2",
      "description": "Updated description for the JS badge"
    }
  }'

Răspuns

{
  "statusCode": 200,
  "info": {
    "badgeId": "https://api.badges.ninja/certify-badge/badge/b1c2d3e4-...",
    "updated": true
  }
}

---

Actualizează textul de distribuire

Setează textul personalizat afișat atunci când destinatarii distribuie această credențială pe rețelele sociale.

PUT /badges/{badgeId}/share-text

Parametri

Parametru	Tip	Obligatoriu	Descriere
badgeId	string	Da	ID-ul credențialei (parametru de rută)
text	string	Da	Text de distribuire (fără HTML)

Exemplu

curl -X PUT https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901/share-text \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "badgeId": "b1c2d3e4-f5a6-7890-bcde-f12345678901",
      "text": "I just earned the JavaScript Fundamentals badge! Check it out:"
    }
  }'

Răspuns

{
  "statusCode": 200,
  "info": {
    "updated": true
  }
}

---

Șterge credențială

Șterge o credențială. Nu trebuie să aibă acordări asociate.

DELETE /badges/{badgeId}

Exemplu

curl -X DELETE https://api.badges.ninja/badges/b1c2d3e4-f5a6-7890-bcde-f12345678901 \
  -H "X-Api-Key: bws_your_api_key_here"

Răspuns

{
  "statusCode": 200,
  "info": {
    "deleted": true
  }
}

Erori

• 400 — credențiala are acordări și nu poate fi ștearsă
• 404 — credențială negăsită