အထောက်အထားစစ်ဆေးခြင်းနှင့် အကောင့် Endpoint

Request တိုင်းတွင် header တစ်ခု ပါဝင်ပါသည်။ API Key အလုပ်လုပ်ကြောင်း စစ်ရန်၊ အော်ဒါများအတွက် ငွေဖြတ်ယူမည့် Wallet လက်ကျန်ငွေကို ကြည့်ရန်နှင့် batch run မစတင်မီ အကောင့် ဖွင့်ထားကြောင်း အတည်ပြုရန် GET /account ကို ခေါ်ပါ။

တောင်းဆိုမှုကို အထောက်အထား စစ်ဆေးပုံ

Authorization ခေါင်းစီးတွင် Bearer အထောက်အထားကို ထည့်ပေးရပါမည်။ ၎င်းသည် Key ID နှင့် လျှို့ဝှက်ကုဒ် (secret) ကို အစက် (.) ဖြင့် ဆက်ထားသော ပုံစံ ဖြစ်ပါသည်။ Key ID ဖြင့် မည်သည့်အကောင့်ဖြစ်ကြောင်း ရွေးချယ်ပြီး လျှို့ဝှက်ကုဒ်ကို HMAC နှိုင်းယှဉ်မှုဖြင့် စစ်ဆေးပါသည်။ စစ်ဆေးမှု မအောင်မြင်ပါက လမ်းကြောင်း၏ လုပ်ဆောင်ချက် မစတင်မီ 401 နှင့်အတူ MISSING_API_KEY သို့မဟုတ် INVALID_API_KEY ကို ပြန်ပေးပါသည်။ ဤခေါင်းစီးမှလွဲ၍ အခြားမည်သည့်အရာကိုမျှ မစစ်ဆေးပါ။ Cookie၊ CSRF token နှင့် Origin ခေါင်းစီးတို့ကို ကြည့်ခြင်းမရှိပါ။

ခွင့်ပြုထားသော IP စာရင်း

Key တစ်ခုကို သတ်မှတ်ထားသော source address များနှင့်သာ ချိတ်ထားနိုင်ပါသည်။ ထိုစာရင်းတွင် address ရှိနေသရွေ့ အခြား address မှ တောင်းဆိုမှုကို IP_NOT_ALLOWED နှင့် HTTP 403 ဖြင့် ငြင်းပယ်ပါသည်။ ဤစစ်ဆေးမှုကို တောင်းဆိုနှုန်း ကန့်သတ်ချက်နှင့် Wallet ကြည့်ရှုမှု မတိုင်မီ လုပ်ဆောင်သဖြင့် ခိုးယူခံရသော credential ကို သင့် infrastructure ပြင်ပမှ သုံး၍ မရပါ။ စာရင်း ဗလာဖြစ်ပါက key ကို မည်သည့်နေရာမှမဆို အသုံးပြုနိုင်ပါသည်။

အကောင့် အခြေအနေ

အကောင့်အဆင့် အခြေအနေတစ်ခုက Endpoint အားလုံးကို ချက်ချင်း ရပ်တန့်စေပါသည်။ Freeze လုပ်ထားသော အကောင့်သည် HTTP 403 နှင့်အတူ ACCOUNT_FROZEN ကို ပြန်ပေးပါသည်။ ၎င်းသည် အလိုအလျောက် ပြန်မပွင့်သောကြောင့် Loop ဖြင့် ထပ်ခါ ပြန်ပို့မနေဘဲ ဝန်ထမ်းထံ တင်ပြပါ။

Key လဲလှယ်ခြင်း

Key များကို Reseller panel ရှိ API Access စာမျက်နှာတွင် ဖန်တီးခြင်းနှင့် ဖျက်ခြင်း ပြုလုပ်နိုင်ပါသည်။ Secret ကို ဖန်တီးချိန်တွင် တစ်ကြိမ်သာ ပြသဖြင့် key လဲလှယ်ရာတွင် ရှိပြီးသားကို ပြင်ခြင်းမဟုတ်ဘဲ အသစ်ဖန်တီး၊ deploy လုပ်ပြီးမှ အဟောင်းကို ဖျက်ရပါမည်။ Credential များ အလိုအလျောက် သက်တမ်းမကုန်သဖြင့် မည်သည့်အချိန်တွင် လဲမည်ကို သင်ကိုယ်တိုင် သတ်မှတ်ရပါမည်။

GET

/account

အကောင့်အချက်အလက် ရယူခြင်း

Wallet လက်ကျန်ငွေ၊ အကောင့်အခြေအနေနှင့် အကောင့်ဖွင့်သည့်ရက်စွဲ အပါအဝင် အကောင့်အသေးစိတ်ကို ရယူပါ။

တောင်းဆိုနှုန်း ကန့်သတ်ချက်အကောင့်တစ်ခုလျှင် 60 req / 60s

တောင်းဆိုမှု

curl -s "https://shop2topup.com/api/endpoints/v1/account" \
  -H "Authorization: Bearer YOUR_KEY_ID.YOUR_KEY_SECRET"

တုံ့ပြန်မှု နမူနာ

{
  "success": true,
  "account": {
    "id": 42,
    "email": "[email protected]",
    "username": "partner_store",
    "client_type": "reseller",
    "wallet": "1250.500000",
    "enabled": true,
    "verified": true,
    "created_at": "2024-01-15T10:30:00Z"
  }
}

ဤစာမျက်နှာမှ တကယ့် တောင်းဆိုမှု ပို့ကြည့်ပါ

ဤလမ်းကြောင်းများကို တိုက်ရိုက်ခေါ်ဆို စမ်းသပ်ရန် API Key ကို ကူးထည့်ပါ။ ထည့်လိုက်သော Key ကို ယခုဖွင့်ထားသော browser tab ထဲတွင်သာ သိမ်းထားပြီး API ထံသို့သာ ပို့ပါသည်။

Enter your API key to use the interactive playground. Get your API key

ခေါ်ဆိုမည့် API လမ်းကြောင်း ရွေးပါ

Enter your API key above to try this endpoint.

Response will appear here after sending a request.

ပလက်ဖောင်းကို စတင်အသုံးပြုသူ ဖြစ်ပါက Reseller များအတွက် ဂိမ်း Top Up API အကျဉ်းချုပ်၊ သို့မဟုတ် SHOP2TOPUP Reseller အစီအစဉ် အကျဉ်းချုပ် ကို ဖတ်၍ ပါတနာအကောင့် မည်သို့ အလုပ်လုပ်သည်ကို လေ့လာပါ။