External API

External API က အခြားစနစ်တွေကို သင့် workspace ထဲက အချက်အလက်တွေ ဖတ်ခွင့်ပေးပါတယ် — ဥပမာ ကုန်သည်ရဲ့ online shop မှာ checkout လုပ်ချိန် ပို့ခပြသခြင်း ဒါမှမဟုတ် သင့်ဝဘ်ဆိုက်ပေါ်က ခြေရာခံစာမျက်နှာ တို့လိုမျိုးပါ။

API key ရယူခြင်း

Admin က ဆက်တင် → API Key ကိုဖွင့်ပြီး API Key ထုတ်ရန် ကို ရွေးပါ။ ဒါက တစ်ကြိမ်ပဲ ပြသမှာမို့ ချက်ချင်း ကူးယူထားပါ။ regenerate လုပ်နိုင်ပြီး (key အဟောင်းက ချက်ချင်း အလုပ်မလုပ်တော့ပါ) revoke လည်း လုပ်နိုင်ပါတယ်။

Request ပို့ခြင်း

သင့်ကုမ္ပဏီရဲ့ လိပ်စာ ဆီကို X-API-Key header ထဲမှာ key ထည့်ပြီး request ပို့ပါ။

curl https://shwe-express.mmdeliapp.com/api/external/townships \
  -H "X-API-Key: YOUR_KEY" \
  -H "Accept: application/json"

Key မပါရင် ဒါမှမဟုတ် မှားနေရင် 401 နဲ့အတူ {"error": {"code": "invalid_api_key"}} ပြန်ပေးပါတယ်။

Endpoint များ

မြို့နယ်စာရင်း

GET /api/external/townships

သင့်မြို့နယ်တွေကို ID နဲ့ code တွေနဲ့အတူ ပြန်ပေးပါတယ်။ စျေးနှုန်းတွက်ရန် အတွက် ID တွေကို သုံးပါ။

ပို့ခ တွက်ချက်ခြင်း

POST /api/external/pricing

{
  "township_id": 12,
  "from_township_id": 3,
  "weight_kg": 2.5
}

from_township_id က optional ဖြစ်ပါတယ်။ Response မှာ ကုန်ကျစရိတ်ကို ခွဲပြပါတယ်။

{
  "data": {
    "township_id": 12,
    "township_name": "Hlaing",
    "weight_kg": 2.5,
    "delivery_fee": "2500.00",
    "kg_fee": "500.00",
    "transfer_fee": "0.00",
    "total_fee": "3000.00",
    "currency": "MMK"
  }
}

အဲဒီလမ်းကြောင်းအတွက် စျေးနှုန်း မသတ်မှတ်ထားဘူးဆိုရင် 404 နဲ့အတူ Pricing not found for this route ဆိုတဲ့ response ပြန်လာပါတယ်။

ပါဆယ် ခြေရာခံခြင်း

GET /api/external/parcels/{public_tracking_code}

ပါဆယ်ရဲ့ လက်ရှိ status၊ လက်ခံမယ့်သူ၊ မြို့နယ်၊ အဓိကရက်စွဲတွေ (pickup, delivery, received) နဲ့ status history ကို ပြန်ပေးပါတယ်။ VR code မဟုတ်ဘဲ public tracking code ကို သုံးပါ။ status တစ်ခုစီရဲ့ အဓိပ္ပာယ်ကို ပါဆယ် လုပ်ငန်းစဉ် မှာ ကြည့်ပါ။