Kļūdas

Ja API pieprasījums neizdodas, badges.ninja atgriež JSON kļūdas atbildi ar atbilstošu HTTP statusa kodu.

Kļūdas formāts

Visām kļūdām ir šāda struktūra:

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

Statusa kodi

Kods	Nozīme	Kad tas notiek
400	Bad Request	Trūkst parametru vai tie nav derīgi, sasniegts plāna limits vai kvota, funkcijai nepieciešams augstāks plāns vai nav autorizācijas — visas validācijas kļūmes atgriež 400
402	Payment Required	Rezervēts kredītu izsmelšanai. badges API pašlaik neatskaita kredītus, tāpēc šis kods praksē nekad netiek atgriezts
404	Not Found	Pieprasītais resurss nepastāv
500	Internal Server Error	Serverī radās neparedzēta kļūda

Kodu 403 vai 429 nav: autorizācijas kļūmes atgriež 400 („not authorized”), un lietojumprogrammas līmenī pieprasījumu ātruma ierobežojumu nav.

Biežākās kļūdas un risinājumi

Trūkst obligāto parametru

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

Risinājums: Iekļaujiet pieprasījuma pamattekstā visus obligātos parametrus. Pilnu sarakstu skatiet galapunkta dokumentācijā.

Nederīga e-pasta adrese

{ "error": "invalid email" }

Risinājums: Norādiet derīgu e-pasta adresi formātā user@domain.com.

Nederīgs URL

{ "error": "invalid URL" }

Risinājums: Norādiet pilnu URL kopā ar protokolu, piemēram, https://example.com.

Nosaukums par īsu

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

Risinājums: Izmantojiet garāku nosaukumu. Izdevēju nosaukumiem jābūt vismaz 3 rakstzīmēm, saņēmēju vārdiem — vismaz 5 rakstzīmēm.

Izdevējs nav verificēts

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

Risinājums: Vispirms verificējiet izdevēju. Verifikācijas saiti meklējiet izdevēja e-pastā vai izmantojiet galapunktu Verificēt izdevēju.

Sasniegta apliecinājumu kvota (400)

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

Risinājums: Esat izmantojis visu gada apliecinājumu kopu (Free: 1 200 gadā, Starter: 12 000 gadā, Pro: 120 000 gadā). Kopa tiek atiestatīta jūsu konta reģistrācijas gadadienā, nevis kalendārā mēneša robežā. Lai iegūtu lielāku apjomu, atjauniniet savu plānu. Skatiet Plāni un norēķini.

Sasniegts plāna limits (400)

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

Nozīmju ierobežojumam ir tāda pati forma:

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

Risinājums: Esat sasniedzis sava plāna izdevēju vai nozīmju ierobežojumu. Dzēsiet neizmantotu resursu vai atjauniniet plānu.

Resursam ir atkarības (400)

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

Risinājums: Pirms izdevēja dzēšanas izdzēsiet visas ar to saistītās nozīmes. Līdzīgi pirms nozīmes dzēšanas izdzēsiet visus tās apliecinājumus.

Nav autorizācijas (400)

{ "error": "not authorized" }

Autorizācijas kļūmes ir validācijas kļūdas, tāpēc tās atgriež 400 (nevis 401 vai 403).

Risinājums: Varat mainīt tikai savus resursus. Pārliecinieties, ka izmantojat pareizo API atslēgu.

HTML kopīgošanas tekstā

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

Risinājums: Kopīgošanas tekstam jābūt vienkāršam tekstam. Noņemiet visas HTML birkas no text parametra.