Issuers API

Pārvaldiet nozīmju izsniedzējus — organizācijas vai personas, kas pasniedz nozīmes.

Visi galapunkti prasa autentifikāciju caur galveni X-Api-Key. Skatiet Autentifikācija.

Izveidot izsniedzēju

Izveidot jaunu nozīmju izsniedzēju.

POST /issuers

Parametri

Parametrs	Tips	Obligāts	Apraksts
name	string	Jā	Organizācijas nosaukums (vismaz 3 rakstzīmes)
url	string	Jā	Organizācijas tīmekļa vietne (jābūt derīgai HTTP/HTTPS URL)
email	string	Jā	Izsniedzēja kontakta e-pasts
logo	string	Nē	Base64 kodēts attēls (PNG vai JPG)
linkedinOrganizationId	string	Nē	Ciparu LinkedIn uzņēmuma lapas ID. Kad iestatīts, katra publiskā apbalvojuma lapa no šī izsniedzēja rāda pogu Add to LinkedIn Profile.

Piemērs

curl -X POST https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "name": "Acme Academy",
      "url": "https://acme.example.com",
      "email": "badges@acme.example.com"
    }
  }'

Atbilde

{
  "statusCode": 200,
  "info": {
    "issuerId": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Piezīmes

• Skaitās pret jūsu plāna izsniedzēju ierobežojumu (Free: 1, Starter: 5, Pro: neierobežots). Nav kvotas samazinājuma.
• Ja izsniedzēja e-pasts sakrīt ar jūsu konta e-pastu, izsniedzējs tiek automātiski pārbaudīts.
• Ja e-pasts atšķiras, uz izsniedzēja e-pastu tiek nosūtīta apstiprināšanas vēstule.

---

Uzskaitīt izsniedzējus

Iegūt visus jūsu izveidotos izsniedzējus.

GET /issuers

Piemērs

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

Atbilde

{
  "statusCode": 200,
  "info": {
    "issuers": [
      {
        "id": "https://api.badges.ninja/certify-badge/issuer/a1b2c3d4-...",
        "name": "Acme Academy",
        "url": "https://acme.example.com",
        "email": "badges@acme.example.com",
        "verified": true,
        "timestamp": "2025-01-15T10:30:00.000Z"
      }
    ]
  }
}

---

Pārbaudīt izsniedzēju

Pārbaudīt izsniedzēju, izmantojot apstiprināšanas kodu, kas nosūtīts uz tā e-pastu.

POST /issuers/{issuerId}/verify

Parametri

Parametrs	Tips	Obligāts	Apraksts
issuerId	string	Jā	Izsniedzēja ID (ceļa parametrs)
code	string	Jā	Apstiprināšanas kods no e-pasta

Piemērs

curl -X POST https://api.badges.ninja/issuers/a1b2c3d4-e5f6-7890-abcd-ef1234567890/verify \
  -H "X-Api-Key: bws_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters": {
      "issuerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "code": "ABC123"
    }
  }'

Atbilde

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

---

Dzēst izsniedzēju

Dzēst izsniedzēju. Izsniedzējam nedrīkst būt nozīmes.

DELETE /issuers/{issuerId}

Piemērs

curl -X DELETE https://api.badges.ninja/issuers/a1b2c3d4-e5f6-7890-abcd-ef1234567890 \
  -H "X-Api-Key: bws_your_api_key_here"

Atbilde

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

Kļūdas

• 400 — izsniedzējam ir nozīmes vai apbalvojumi un to nevar dzēst (vispirms dzēsiet tos)
• 404 — izsniedzējs nav atrasts

---

Atjaunināt izsniedzēju

Atjaunināt nepārbaudīta izsniedzēja laukus. Kad izsniedzējs ir pārbaudīts, tikai logo un linkedinOrganizationId paliek rediģējami, lai saglabātu apliecinājuma stabilitāti.

PUT /issuers/{issuerId}

Parametri

Parametrs	Tips	Obligāts	Apraksts
issuerId	string	Jā	Izsniedzēja ID (ceļa parametrs)
name	string	Nē	Jauns nosaukums (tikai kad nepārbaudīts)
url	string	Nē	Jauns URL (tikai kad nepārbaudīts)
email	string	Nē	Jauns e-pasts (tikai kad nepārbaudīts — nosūta jaunu apstiprināšanas vēstuli)
logo	string	Nē	Jauns base64 kodēts logotips
linkedinOrganizationId	string	Nē	Jauns LinkedIn organizācijas ID (vai tukša virkne, lai notīrītu)

---

Apstiprināšanas koda rotēšana

Anulēt iepriekšējo apstiprināšanas saiti un nosūtīt jaunu. Derīgs tikai tad, kamēr izsniedzējs vēl nav pārbaudīts.

POST /issuers/{issuerId}/rotate-code

Atbilde

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