Ralat

Apabila permintaan API gagal, badges.ninja mengembalikan tindak balas ralat JSON dengan kod status HTTP yang sesuai.

Format Ralat

Semua ralat mengikuti struktur ini:

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

Kod Status

Kod	Maksud	Bila Berlaku
400	Bad Request	Parameter hilang atau tidak sah
402	Payment Required	Kuota anugerah bulanan tercapai atau ciri memerlukan pelan lebih tinggi
403	Forbidden	Had pelan tercapai (cth. had pengeluar atau lencana)
404	Not Found	Sumber yang diminta tidak wujud
429	Too Many Requests	Had kadar dilampaui
500	Internal Server Error	Ralat tidak dijangka berlaku pada pelayan

Ralat Biasa dan Penyelesaian

Parameter yang diperlukan hilang

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

Penyelesaian: Sertakan semua parameter yang diperlukan dalam badan permintaan anda. Semak dokumentasi endpoint untuk senarai penuh.

E-mel tidak sah

{ "error": "invalid email" }

Penyelesaian: Berikan alamat e-mel yang sah dalam format user@domain.com.

URL tidak sah

{ "error": "invalid URL" }

Penyelesaian: Berikan URL penuh termasuk protokol, cth. https://example.com.

Nama terlalu pendek

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

Penyelesaian: Gunakan nama yang lebih panjang. Nama pengeluar memerlukan minimum 3 aksara. Nama penerima memerlukan minimum 5 aksara.

Pengeluar tidak disahkan

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

Penyelesaian: Sahkan pengeluar dahulu. Semak e-mel pengeluar untuk pautan pengesahan, atau gunakan endpoint Sahkan Pengeluar.

Kuota anugerah bulanan tercapai

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

Penyelesaian: Anda telah menggunakan semua anugerah yang termasuk dalam pelan anda untuk tempoh pengebilan ini (Free: 100/mo, Starter: 1,000/mo, Pro: 10,000/mo). Tunggu set semula seterusnya atau naik taraf pelan anda. Lihat Pelan & Pengebilan.

Had pelan tercapai

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

Penyelesaian: Anda telah mencapai had pelan anda pada pengeluar, lencana atau kunci API. Padam sumber yang tidak digunakan atau naik taraf pelan anda.

Blockchain memerlukan Pro

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

Penyelesaian: Parameter blockchain hanya tersedia pada pelan Pro. Naik taraf untuk mendayakan pengesahan on-chain.

Blockchain tidak disokong

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

Penyelesaian: Pada masa ini hanya matchain disokong sebagai parameter blockchain.

Sumber mempunyai kebergantungan

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

Penyelesaian: Padam semua lencana di bawah pengeluar sebelum memadam pengeluar. Begitu juga, padam semua anugerah di bawah lencana sebelum memadam lencana.

Tidak dibenarkan

{ "error": "not authorized" }

Penyelesaian: Anda hanya boleh mengubah suai sumber yang anda miliki. Pastikan anda menggunakan kunci API yang betul.

HTML dalam teks perkongsian

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

Penyelesaian: Teks perkongsian mestilah teks biasa. Buang sebarang teg HTML daripada parameter teks.