Langsung ke konten utama

Format Respons

Semua respons Wappfy API mengikuti format envelope yang konsisten.

Respons sukses

Setiap respons sukses dibungkus dalam objek standar:
{
  "success": true,
  "data": { ... },
  "meta": {
    "requestId": "req_abc123",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
FieldTipeDeskripsi
successbooleanSelalu true untuk respons sukses
dataobject | arrayPayload respons
meta.requestIdstringPengenal permintaan unik untuk debugging
meta.timestampstringTimestamp ISO 8601

Respons berpaginasi

Endpoint yang mengembalikan daftar menyertakan metadata paginasi:
{
  "success": true,
  "data": {
    "items": [ ... ],
    "total": 42,
    "page": 1,
    "limit": 20,
    "totalPages": 3
  },
  "meta": {
    "requestId": "req_def456",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}
Gunakan parameter query page dan limit untuk mengontrol paginasi:
GET /api/instances?page=2&limit=10

Respons error

Permintaan yang gagal mengembalikan objek error:
{
  "success": false,
  "error": {
    "code": "INSTANCE_NOT_FOUND",
    "message": "Instance with ID abc123 not found",
    "details": {}
  },
  "meta": {
    "requestId": "req_ghi789",
    "timestamp": "2026-02-10T12:00:00.000Z"
  }
}

Kode error umum

Status HTTPKodeDeskripsi
400VALIDATION_ERRORBody permintaan gagal validasi
401UNAUTHORIZEDToken autentikasi tidak ada atau tidak valid
403FORBIDDENIzin tidak mencukupi
404NOT_FOUNDResource tidak ditemukan
409PLAN_LIMIT_REACHEDBatas instance untuk paket Anda
429RATE_LIMIT_EXCEEDEDTerlalu banyak permintaan
500INTERNAL_ERRORError server yang tidak terduga
meta.requestId berguna untuk permintaan bantuan — sertakan saat menghubungi dukungan untuk proses debugging yang lebih cepat.