Klaidos

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

Klaidos formatas

Visos klaidos atitinka šią struktūrą:

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

Būsenos kodai

Kodas	Reikšmė	Kada tai įvyksta
400	Bad Request	Trūksta arba netinkami parametrai
402	Payment Required	Pasiekta mėnesio apdovanojimų kvota arba funkcija reikalauja aukštesnio plano
403	Forbidden	Pasiektas plano limitas (pvz., išdavėjo ar ženklelio riba)
404	Not Found	Prašomas išteklius nerastas
429	Too Many Requests	Viršytas greičio limitas
500	Internal Server Error	Serveryje įvyko netikėta klaida

Dažnos klaidos ir sprendimai

Trūksta privalomų parametrų

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

Sprendimas: įtraukite visus privalomus parametrus į savo užklausos kūną. Visą sąrašą žiūrėkite galutinio taško dokumentacijoje.

Netinkamas el. paštas

{ "error": "invalid email" }

Sprendimas: pateikite galiojantį el. pašto adresą formatu user@domain.com.

Netinkamas URL

{ "error": "invalid URL" }

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

Pavadinimas per trumpas

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

Sprendimas: naudokite ilgesnį pavadinimą. Išdavėjų pavadinimams reikalaujama mažiausiai 3 simbolių. Gavėjų vardams reikalaujama mažiausiai 5 simbolių.

Išdavėjas nepatvirtintas

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

Sprendimas: pirmiausia patvirtinkite išdavėją. Patikrinkite išdavėjo el. paštą dėl patvirtinimo nuorodos arba naudokite galutinį tašką Patvirtinti išdavėją.

Pasiekta mėnesio apdovanojimų kvota

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

Sprendimas: išnaudojote visus į jūsų planą įtrauktus apdovanojimus šiam atsiskaitymo laikotarpiui (Free: 100/mėn, Starter: 1 000/mėn, Pro: 10 000/mėn). Palaukite kito atstatymo arba atnaujinkite savo planą. Žr. Planai ir atsiskaitymas.

Pasiektas plano limitas

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

Sprendimas: pasiekėte savo plano ribą dėl išdavėjų, ženklelių arba API raktų. Ištrinkite nenaudojamą išteklių arba atnaujinkite savo planą.

Blokų grandinei reikia Pro

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

Sprendimas: parametras blockchain prieinamas tik Pro plane. Atnaujinkite, kad įjungtumėte grandinės patikrą.

Nepalaikoma blokų grandinė

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

Sprendimas: šiuo metu kaip blokų grandinės parametras palaikomas tik matchain.

Išteklius turi priklausomybių

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

Sprendimas: ištrinkite visus ženklelius po išdavėju prieš ištrindami išdavėją. Panašiai ištrinkite visus apdovanojimus po ženkleliu prieš ištrindami ženklelį.

Neįgaliotas

{ "error": "not authorized" }

Sprendimas: galite keisti tik tuos išteklius, kuriuos valdote. Į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š teksto parametro.