Klaidos

Kai API užklausa nepavyksta, badges.ninja grąžina JSON klaidos atsakymą su atitinkamu HTTP būsenos kodu.

Klaidos formatas

Visos klaidos turi tokią struktūrą:

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

Būsenos kodai

Kodas	Reikšmė	Kada įvyksta
400	Bad Request	Trūksta parametrų arba jie neteisingi, pasiektas plano limitas ar kvota, funkcijai reikalingas aukštesnis planas arba nėra leidimo — visi patvirtinimo (validacijos) nesėkmių atvejai grąžina 400
402	Payment Required	Rezervuotas kreditų išsekimui. Šiuo metu badges API kreditų nenuskaičiuoja, todėl praktiškai šis kodas niekada negrąžinamas
404	Not Found	Prašomo ištekliaus nėra
500	Internal Server Error	Serveryje įvyko netikėta klaida

Kodų 403 ar 429 nėra: leidimo nesėkmės grąžina 400 („not authorized“), o programos lygmens užklausų dažnio ribojimo nėra.

Dažniausios klaidos ir sprendimai

Trūksta privalomų parametrų

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

Sprendimas: Įtraukite visus privalomus parametrus į užklausos turinį. Visą sąrašą rasite galutinio taško dokumentacijoje.

Neteisingas el. paštas

{ "error": "invalid email" }

Sprendimas: Nurodykite tinkamą el. pašto adresą formatu user@domain.com.

Neteisingas URL

{ "error": "invalid URL" }

Sprendimas: Nurodykite pilną URL kartu su protokolu, pvz., https://example.com.

Per trumpas pavadinimas

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

Sprendimas: Naudokite ilgesnį pavadinimą. Išdavėjų pavadinimai turi būti bent 3 simbolių, gavėjų vardai – bent 5 simbolių.

Išdavėjas nepatikrintas

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

Sprendimas: Pirmiausia patikrinkite išdavėją. Raskite patikrinimo nuorodą išdavėjo el. pašte arba naudokite galutinį tašką Patikrinti išdavėją.

Pasiekta pažymėjimų kvota (400)

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

Sprendimas: Išnaudojote visą metinį pažymėjimų fondą (Free: 1 200 per metus, Starter: 12 000 per metus, Pro: 120 000 per metus). Fondas atnaujinamas jūsų paskyros registracijos metinių dieną, o ne kalendorinio mėnesio pabaigoje. Norėdami gauti didesnę kvotą, atnaujinkite planą. Žr. Planai ir atsiskaitymas.

Pasiektas plano limitas (400)

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

Ženklelių riba turi tą pačią formą:

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

Sprendimas: Pasiekėte savo plano išdavėjų arba ženklelių ribą. Ištrinkite nenaudojamą išteklių arba atnaujinkite planą.

Išteklius turi priklausomų elementų (400)

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

Sprendimas: Prieš ištrindami išdavėją, ištrinkite visus su juo susietus ženklelius. Panašiai prieš ištrindami ženklelį ištrinkite visus jo pažymėjimus.

Nėra leidimo (400)

{ "error": "not authorized" }

Leidimo nesėkmės yra patvirtinimo (validacijos) klaidos, todėl grąžina 400 (o ne 401 ar 403).

Sprendimas: Modifikuoti galite tik savo išteklius. Įsitikinkite, kad naudojate teisingą API raktą.

HTML dalijimosi tekste

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

Sprendimas: Dalijimosi tekstas turi būti paprastas tekstas. Pašalinkite visas HTML žymas iš text parametro.