Vead

Kui API päring ebaõnnestub, tagastab badges.ninja JSON-veavastuse sobiva HTTP olekukoodiga.

Vea vorming

Kõik vead on järgmise struktuuriga:

{
  "error": "description of what went wrong"
}

Olekukoodid

Kood	Tähendus	Millal see tekib
400	Bad Request	Puuduvad või kehtetud parameetrid, paketi piir või kvoot täis, funktsioon nõuab kõrgemat paketti või puudub luba — kõik valideerimisvead tagastavad 400
402	Payment Required	Reserveeritud krediitide ammendumiseks. Märkide API praegu krediite maha ei arvesta, seega seda koodi praktikas kunagi ei tagastata
404	Not Found	Soovitud ressurssi ei eksisteeri
500	Internal Server Error	Serveris tekkis ootamatu viga

Koode 403 ja 429 ei ole: autoriseerimisvead tagastavad 400 ("not authorized") ning rakenduse tasandil päringupiirangut ei ole.

Levinud vead ja lahendused

Kohustuslikud parameetrid puuduvad

{ "error": "missing required parameters: name, url, email" }

Lahendus: Lisa päringu kehasse kõik kohustuslikud parameetrid. Täieliku loendi leiad otspunkti dokumentatsioonist.

Kehtetu e-posti aadress

{ "error": "invalid email" }

Lahendus: Sisesta kehtiv e-posti aadress kujul user@domain.com.

Kehtetu URL

{ "error": "invalid URL" }

Lahendus: Sisesta täielik URL koos protokolliga, nt https://example.com.

Nimi on liiga lühike

{ "error": "name must be at least 3 characters" }

Lahendus: Kasuta pikemat nime. Väljaandjate nimed peavad olema vähemalt 3 tähemärki pikad. Saajate nimed peavad olema vähemalt 5 tähemärki pikad.

Väljaandja ei ole kinnitatud

{ "error": "issuer must be verified before creating badges" }

Lahendus: Kinnita esmalt väljaandja. Otsi kinnituslinki väljaandja e-kirjast või kasuta otspunkti Kinnita väljaandja.

Tõendite kvoot täis (400)

{ "error": "Your Free plan reached its credential limit (1200/1200) — your allowance renews on your plan anniversary, or upgrade to Starter" }

Lahendus: Oled kasutanud kogu oma aastase tõendite varu (Free: 1 200/aastas, Starter: 12 000/aastas, Pro: 120 000/aastas). Varu lähtestatakse sinu konto registreerimise aastapäeval — mitte kalendrikuu vahetumisel. Suurema limiidi saamiseks uuenda oma pakett. Vt Paketid ja arveldus.

Paketi piir täis (400)

{ "error": "Your Free plan reached its issuer limit (2/2) — delete an issuer or upgrade to Starter" }

Märkide piirang on samas vormingus:

{ "error": "badge limit reached (5/5 on the starter plan) — delete a badge or upgrade your plan" }

Lahendus: Oled jõudnud oma paketi ülempiirini väljaandjate või märkide osas. Kustuta mittevajalik ressurss või uuenda oma pakett.

Ressursil on sõltuvusi (400)

{ "error": "issuer has 3 badge(s) linked — delete the badges first" }

Lahendus: Kustuta enne väljaandja kustutamist kõik temaga seotud märgid. Samamoodi kustuta enne märgi kustutamist kõik selle märgi tõendid.

Luba puudub (400)

{ "error": "not authorized" }

Autoriseerimisvead on valideerimisvead, seega tagastavad nad 400 (mitte 401 ega 403).

Lahendus: Saad muuta ainult oma ressursse. Veendu, et kasutad õiget API võtit.

HTML jagatavas tekstis

{ "error": "HTML tags are not allowed" }

Lahendus: Jagatav tekst peab olema lihttekst. Eemalda parameetrist text kõik HTML-sildid.