Vead

Kui API-päring nurjub, tagastab badges.ninja JSON-veavastuse koos sobiva HTTP-staatusekoodi.

Veavorming

Kõik vead järgivad seda struktuuri:

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

Staatusekoodid

Kood	Tähendus	Millal see juhtub
400	Bad Request	Puuduvad või vigased parameetrid
402	Payment Required	Kuukvoodist autasudega on saavutatud või funktsioon nõuab kõrgemat plaani
403	Forbidden	Plaani piir saavutatud (nt väljastaja või märgi lagi)
404	Not Found	Taotletud ressurssi pole olemas
429	Too Many Requests	Kiiruspiirang ületatud
500	Internal Server Error	Serveril tekkis ootamatu viga

Tavalised vead ja lahendused

Puuduvad nõutavad parameetrid

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

Lahendus: lisa oma päringu kehasse kõik nõutavad parameetrid. Kontrolli otspunkti dokumentatsiooni täieliku loendi jaoks.

Vigane e-post

{ "error": "invalid email" }

Lahendus: esita kehtiv e-posti aadress vormingus user@domain.com.

Vigane URL

{ "error": "invalid URL" }

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

Nimi liiga lühike

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

Lahendus: kasuta pikemat nime. Väljastaja nimed nõuavad vähemalt 3 tähemärki. Saaja nimed nõuavad vähemalt 5 tähemärki.

Väljastaja ei ole kinnitatud

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

Lahendus: kinnita väljastaja esmalt. Kontrolli väljastaja e-posti kinnituslingi jaoks või kasuta otspunkti Kinnita väljastaja.

Kuukvoot on saavutatud

{ "error": "monthly award quota reached" }

Lahendus: oled käesolevaks arveldusperioodiks kasutanud ära kõik oma plaani sisalduvad autasud (Free: 100/kuus, Starter: 1 000/kuus, Pro: 10 000/kuus). Oota järgmist lähtestamist või uuenda oma plaani. Vt Plaanid ja arveldus.

Plaani piir on saavutatud

{ "error": "issuer limit reached for your plan" }

Lahendus: oled saavutanud oma plaani lae väljastajate, märkide või API-võtmete osas. Kustuta kasutamata ressurss või uuenda oma plaani.

Plokiahel nõuab Pro-d

{ "error": "blockchain verification requires the Pro plan" }

Lahendus: parameeter blockchain on saadaval ainult Pro plaanis. Uuenda, et lubada ahelkontroll.

Toetamata plokiahel

{ "error": "unsupported blockchain, only 'matchain' is supported" }

Lahendus: praegu on plokiahela parameetrina toetatud ainult matchain.

Ressursil on sõltuvusi

{ "error": "issuer has badges and cannot be deleted" }

Lahendus: kustuta kõik väljastaja all olevad märgid, enne kui kustutad väljastaja. Samuti kustuta kõik märgi all olevad autasud, enne kui kustutad märgi.

Pole volitatud

{ "error": "not authorized" }

Lahendus: saad muuta ainult ressursse, mida omad. Veendu, et kasutad õiget API-võtit.

HTML jagamistekstis

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

Lahendus: jagamistekst peab olema tavaline tekst. Eemalda kõik HTML-sildid teksti parameetrist.