Skip to content

Mga Error

Kapag nabigo ang isang API request, nagre-return ang badges.ninja ng JSON error response na may angkop na HTTP status code.

Format ng Error

Lahat ng error ay sumusunod sa istrukturang ito:

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

Mga Status Code

CodeKahuluganKailan Nangyayari
400Bad RequestNawawalang o invalid na parameter
402Payment RequiredNaabot ang buwanang quota ng award o ang feature ay nangangailangan ng mas mataas na plan
403ForbiddenNaabot ang plan-limit (hal. issuer o badge cap)
404Not FoundHindi umiiral ang hiniling na resource
429Too Many RequestsNalampasan ang rate limit
500Internal Server ErrorMay di-inaasahang error na nangyari sa server

Mga Karaniwang Error at Solusyon

Nawawalang kinakailangang parameter

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

Solusyon: Isama ang lahat ng kinakailangang parameter sa inyong request body. Tingnan ang dokumentasyon ng endpoint para sa buong listahan.

Invalid na email

json
{ "error": "invalid email" }

Solusyon: Magbigay ng balidong email address sa format na user@domain.com.

Invalid na URL

json
{ "error": "invalid URL" }

Solusyon: Magbigay ng buong URL kasama ang protocol, hal. https://example.com.

Masyadong maikli ang pangalan

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

Solusyon: Gumamit ng mas mahabang pangalan. Ang mga pangalan ng issuer ay nangangailangan ng minimum 3 character. Ang mga pangalan ng tatanggap ay nangangailangan ng minimum 5 character.

Hindi pa verified ang issuer

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

Solusyon: I-verify muna ang issuer. Suriin ang email ng issuer para sa verification link, o gamitin ang Verify Issuer endpoint.

Naabot ang buwanang quota ng award

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

Solusyon: Nagamit na ninyo ang lahat ng award na kasama sa inyong plan para sa billing period na ito (Free: 100/mo, Starter: 1,000/mo, Pro: 10,000/mo). Maghintay para sa susunod na reset o i-upgrade ang inyong plan. Tingnan ang Plans & Billing.

Naabot ang plan limit

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

Solusyon: Naabot ninyo ang cap ng inyong plan sa issuer, badge, o API keys. Burahin ang isang hindi ginagamit na resource o i-upgrade ang inyong plan.

Kailangan ng Pro ang blockchain

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

Solusyon: Ang blockchain parameter ay available lang sa Pro plan. Mag-upgrade para paganahin ang on-chain verification.

Hindi suportadong blockchain

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

Solusyon: Sa kasalukuyan, matchain lang ang sinusuportahan bilang blockchain parameter.

May dependencies ang resource

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

Solusyon: Burahin lahat ng badge sa ilalim ng issuer bago burahin ang issuer. Gayundin, burahin lahat ng award sa ilalim ng badge bago burahin ang badge.

Hindi awtorisado

json
{ "error": "not authorized" }

Solusyon: Maaari lang ninyong baguhin ang mga resource na pag-aari ninyo. Siguraduhing gumagamit kayo ng tamang API key.

HTML sa share text

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

Solusyon: Ang share text ay dapat plain text. Alisin ang anumang HTML tag sa text parameter.

badges.ninja Documentation