Virheet

Kun API-pyyntö epäonnistuu, badges.ninja palauttaa JSON-virhevastauksen sopivalla HTTP-tilakoodilla.

Virheen muoto

Kaikilla virheillä on tämä rakenne:

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

Tilakoodit

Koodi	Merkitys	Milloin se esiintyy
400	Bad Request	Puuttuvat tai virheelliset parametrit, tilausmallin raja tai kiintiö täynnä, ominaisuus vaatii korkeamman tilausmallin tai ei käyttöoikeutta — kaikki validointivirheet palauttavat 400
402	Payment Required	Varattu hyvitysten loppumiselle. Merkki-API ei tällä hetkellä veloita hyvityksiä, joten tätä koodia ei käytännössä koskaan palauteta
404	Not Found	Pyydettyä resurssia ei ole olemassa
500	Internal Server Error	Palvelimella tapahtui odottamaton virhe

Koodeja 403 ja 429 ei ole: käyttöoikeusvirheet palauttavat 400 ("not authorized"), eikä sovellustasolla ole nopeusrajoitusta.

Yleiset virheet ja ratkaisut

Pakolliset parametrit puuttuvat

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

Ratkaisu: Sisällytä kaikki pakolliset parametrit pyynnön runkoon. Täydellinen luettelo löytyy päätepisteen dokumentaatiosta.

Virheellinen sähköpostiosoite

{ "error": "invalid email" }

Ratkaisu: Anna kelvollinen sähköpostiosoite muodossa user@domain.com.

Virheellinen URL

{ "error": "invalid URL" }

Ratkaisu: Anna täydellinen URL protokollan kanssa, esim. https://example.com.

Nimi on liian lyhyt

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

Ratkaisu: Käytä pidempää nimeä. Myöntäjien nimissä on oltava vähintään 3 merkkiä. Vastaanottajien nimissä on oltava vähintään 5 merkkiä.

Myöntäjää ei ole varmennettu

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

Ratkaisu: Varmenna myöntäjä ensin. Etsi varmennuslinkki myöntäjän sähköpostista tai käytä päätepistettä Varmenna myöntäjä.

Todistuskiintiö täynnä (400)

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

Ratkaisu: Olet käyttänyt koko vuotuisen todistusvarantosi (Free: 1 200/vuosi, Starter: 12 000/vuosi, Pro: 120 000/vuosi). Varanto nollautuu tilisi rekisteröitymisen vuosipäivänä — ei kalenterikuun vaihteessa. Päivitä tilausmallisi saadaksesi suuremman kiintiön. Katso Tilausmallit ja laskutus.

Tilausmallin raja saavutettu (400)

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

Merkkien enimmäismäärä noudattaa samaa muotoa:

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

Ratkaisu: Olet saavuttanut tilausmallisi ylärajan myöntäjille tai merkeille. Poista käyttämätön resurssi tai päivitä tilausmallisi.

Resurssilla on riippuvuuksia (400)

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

Ratkaisu: Poista kaikki myöntäjään liitetyt merkit, ennen kuin poistat myöntäjän. Vastaavasti poista kaikki merkin todistukset, ennen kuin poistat merkin.

Ei käyttöoikeutta (400)

{ "error": "not authorized" }

Käyttöoikeusvirheet ovat validointivirheitä, joten ne palauttavat 400 (ei 401 tai 403).

Ratkaisu: Voit muokata vain omistamiasi resursseja. Varmista, että käytät oikeaa API-avainta.

HTML jaettavassa tekstissä

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

Ratkaisu: Jaettavan tekstin on oltava pelkkää tekstiä. Poista kaikki HTML-tagit text-parametrista.