Weegloo Docs

Ketika sebuah permintaan gagal, WEEGLOO mengembalikan body error dengan format yang konsisten beserta kode status HTTP. Bentuk body respons sama tanpa bergantung pada API mana (CMA, CDA, ACMA, ACDA, Upload, Auth) yang mengalami kegagalan. Karena itu, jika Anda menguasai satu format saja, Anda dapat menangani semua error dengan cara percabangan yang sama. Halaman ini merangkum format umum tersebut beserta kode error yang sering ditemui di satu tempat.

Format respons error

Body error memiliki bentuk seperti berikut. Berikut adalah respons yang diterima saat mencoba mengambil WebHosting yang tidak ada.

{
  "requestId": "GeR3sEbvWdgvv9eW2NXeanpj2wo6qbkVXgIW7Qd3ea6",
  "sys": {
    "id": "RxcgyPTSuk4GDy6s",
    "type": "NotFound",
    "code": "WGL404001",
    "timestamp": 1781785683556
  },
  "details": {
    "space": { "sys": { "id": "HnQ32YiH", "type": "Refer", "targetType": "Space" } }
  },
  "reason": "WebHosting(...) has been deleted or does not exist.",
  "suggestion": "Please verify WebHosting and try again."
}

Arti setiap kunci adalah sebagai berikut.

Kunci	Tipe	Keterangan
`requestId`	string	Pengidentifikasi pelacakan untuk permintaan ini. Jika Anda menyertakan nilai ini saat menghubungi dukungan, permintaan terkait dapat ditemukan dengan cepat.
`sys.type`	string	Klasifikasi error. Menunjukkan kategori besar seperti `Unauthorized`, `Forbidden`, `NotFound`, `Unprocessable`, `Conflict`, `TooManyRequest`, dan lainnya.
`sys.code`	string	Kode error rinci (misalnya `WGL409005`). Gunakan nilai ini saat melakukan percabangan per kode.
`sys.timestamp`	integer	Waktu terjadinya error (epoch millis).
`reason`	string	Alasan kegagalan yang dapat dibaca manusia.
`suggestion`	string	Petunjuk yang membantu penyelesaian.
`details`	object (opsional)	Informasi tambahan. Berisi `Refer` yang menunjuk ke sumber daya terkait, daftar item error validasi (`errors`), dan lainnya. Dapat tidak ada tergantung jenis error.

Lakukan percabangan dengan satuan yang Anda perlukan, baik sys.type (kategori besar) maupun sys.code (kode rinci). Meskipun sys.type sama, jika sys.code berbeda maka penyebabnya berbeda, jadi jika Anda memerlukan penanganan yang tepat, gunakan sys.code sebagai acuan.

Ketika validasi gagal, item yang melanggar dimuat dalam details.errors. Berikut adalah respons yang gagal validasi karena memasukkan properti yang tidak ada dalam skema ke dalam body.

{
  "requestId": "yJ8KpQ2mWtnLrZ4Xv7BcEadfh3sNuMvKbGT5Pq9wRsx",
  "sys": {
    "id": "Lm2Nq9Tr8KdW4xZc",
    "type": "BadRequest",
    "code": "WGL400006",
    "timestamp": 1781776000000
  },
  "details": {
    "errors": [
      { "path": "", "message": "property 'X' is not defined in the schema", "property": "X" }
    ]
  },
  "reason": "Some values do not satisfy validation rules.",
  "suggestion": "Please check the request body and try again."
}

Setiap item dalam details.errors memuat posisi yang melanggar (path), keterangan (message), dan nama properti terkait (property). Jika item lebih dari satu, akan ada satu entri untuk setiap nilai yang melanggar.

Kode yang sering ditemui

Berikut adalah kode error yang sering Anda jumpai.

Kode	Klasifikasi	Arti	Situasi umum
`WEB401001`	`Unauthorized`	Token tidak valid	Token Bearer `Authorization` telah kedaluwarsa atau salah.
`WGL403001`	`Forbidden`	Tidak ada izin	Peran pemanggil tidak mengizinkan operasi tersebut.
`WGL404001`	`NotFound`	Sumber daya tidak ada atau telah dihapus	Mengambil dengan `sys.id` yang salah, atau memanggil fitur yang belum disiapkan (misalnya domain kustom yang belum terhubung).
`WGL400006`	BadRequest	Nilai body melanggar aturan validasi	Mengirim body dengan kunci field atau tipe yang salah. Item yang melanggar dimuat dalam `details.errors`.
`WGL409005`	`Conflict`	Sumber daya telah diubah sementara itu	Header `X-Weegloo-Version` tidak ada atau berbeda dengan versi saat ini (lihat Konvensi).
`WGL422007`	`Unprocessable`	Tidak dapat diarsipkan karena berstatus terpublikasi	Untuk mengarsipkan Content atau Media, Anda harus terlebih dahulu membatalkan publikasinya.
`WGL422009`	`Unprocessable`	Tidak dapat dihapus karena berstatus terpublikasi	Untuk menghapus Content atau Media yang telah dipublikasikan, Anda harus terlebih dahulu membatalkan publikasinya.
`WGL429001`	`TooManyRequest`	Batas paket terlampaui	Jumlah pembuatan sumber daya seperti Organization atau Space telah melebihi batas paket saat ini. Menaikkan paket akan menambah batasnya.

Kode di atas adalah sebagian yang sering ditemui. Selain itu, mungkin masih ada lebih banyak kode tergantung operasi dan sumber dayanya. Apa pun kode yang Anda terima, pahami kategori besarnya melalui sys.type, lalu periksa penyebab spesifik dan arah penyelesaiannya melalui reason dan suggestion.

Konvensi: Aturan konkurensi X-Weegloo-Version untuk menghindari WGL409005.
Properti sistem (sys): Status publikasi (status) dan siklus hidup yang ditunjuk oleh WGL422007 dan WGL422009.

Format respons error

Kode yang sering ditemui

Dokumen terkait