FOMDocs

Request နဲ့ error များ

Base URL၊ response ပုံစံ၊ error code နဲ့ rate limit များ။

Request များ

  • Base URL: https://api.getfom.com/public/v1
  • ပုံစံ: ပို့တာ ရတာ JSON ပါ။ Body ပါရင် Content-Type: application/json ပို့ပါ။
  • အချိန် တွေက 2026-11-25T08:00:00.000Z လို UTC နဲ့ ISO 8601 ပါ။ ငွေပမာဏက ဆိုင်ရဲ့ ငွေကြေး (MMK) နဲ့ ကိန်းပြည့်ပါ။
  • Version: v1 က တိုးလာရုံပဲ ရှိပါမယ်။ Field နဲ့ endpoint အသစ်တွေ ပေါ်လာနိုင်လို့ မသိတဲ့ field တွေကို လျစ်လျူရှုပါ။ ပျက်စေမယ့် ပြောင်းလဲမှုတွေကို /public/v2 အဖြစ် ထုတ်ပါမယ်။

Response များ

အောင်မြင်တဲ့ response တိုင်းက ပုံစံ တူပါတယ် -

{
  "success": true,
  "data": { "id": "…", "order_no": "ORD-0319" },
  "meta": {
    "request_id": "req_7f3a2c",
    "timestamp": "2026-11-25T08:00:00.000Z"
  }
}

စာရင်းတွေမှာ meta.pagination ပါပါတယ်။ Pagination နဲ့ sync ကို ကြည့်ပါ။

Error များ

Error တွေက success: false နဲ့ ပုံစံ တူတူ သုံးပါတယ် -

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request is not valid.",
    "details": [
      { "field": "items.0.qty", "errors": ["qty must not be less than 1"] }
    ]
  },
  "meta": { "request_id": "req_7f3a2c", "timestamp": "2026-11-25T08:00:00.000Z" }
}
Statuscodeဘာလုပ်ရမလဲ
401UNAUTHORIZEDKey မှားနေတာ၊ ပယ်ဖျက်ထားတာ၊ သက်တမ်းကုန်တာ ဒါမှမဟုတ် ပြုလုပ်သူ ဆိုင်က ထွက်သွားတာပါ။ Key ကို စစ်ပါ။
403FORBIDDENKey မှာ scope မပါတာ၊ ပြုလုပ်သူမှာ ခွင့်ပြုချက် မရှိတာ၊ IP လိပ်စာ ခွင့်မပြုထားတာ၊ API အသုံးပြုခွင့် မရှိတာ ဒါမှမဟုတ် ဆိုင်က ကြည့်ရုံပဲ ရတဲ့ အခြေအနေ ဖြစ်နေတာပါ။ အဲဒါ မပြောင်းမချင်း ပြန်မကြိုးစားပါနဲ့။
404NOT_FOUNDဒီဆိုင်မှာ ဒီမှတ်တမ်း မရှိပါ။
409CONFLICTတခြားသူ အရင် ပြောင်းသွားတာ (expected_revision) ဒါမှမဟုတ် Idempotency-Key တူတဲ့ request တစ်ခု လုပ်ဆောင်နေဆဲ ဖြစ်ပါတယ်။ ပြန်ဖတ်ပြီးမှ ပြန်ကြိုးစားပါ။
422VALIDATION_ERRORdetails ထဲက field တွေကို ပြင်ပါ။
429TOO_MANY_REQUESTSRetry-After စက္ကန့် စောင့်ပြီး ပြန်ကြိုးစားပါ။
5xxSERVER_ERRORခဏစောင့်ပြီး ပြန်ကြိုးစားပါ။ Idempotency-Key ပါရင် ပြန်ကြိုးစားတဲ့ ပြင်ဆင်မှုက တစ်ကြိမ်ပဲ ဖြစ်ပါတယ်။

Request တစ်ခုအကြောင်း FOM support ကို မေးတဲ့အခါ request_id ကို ပြောပါ။

Rate limit များ

Key တစ်ခုက တစ်မိနစ်ကို request ၁၂၀၊ ဆိုင်တစ်ဆိုင်က key အားလုံးပေါင်း တစ်မိနစ်ကို ၆၀၀ ပို့နိုင်ပါတယ်။ Response တိုင်းက ဘယ်လောက် ကျန်လဲ ပြောပါတယ် -

Headerအဓိပ္ပာယ်
RateLimit-Limitအချိန်ကာလအတွင်း ခွင့်ပြုထားတဲ့ request
RateLimit-Remainingကျန်တဲ့ request
RateLimit-Resetကာလ ပြန်စမယ့် စက္ကန့်
Retry-After429 မှာ စောင့်ရမယ့် စက္ကန့်

ထပ်ခါထပ်ခါ မေးမယ့်အစား updated_since နဲ့ sync လုပ်ပြီး webhook များ သုံးရင် limit အောက်မှာ အေးအေးဆေးဆေး ရှိနေပါမယ်။

ဤစာမျက်နှာတွင်