API v1 · OpenID Connect
သင့်ဝက်ဘ်ဆိုက်ကို သင့်ဂျင်နှင့် ချိတ်ဆက်ပါ။.
အသင်းဝင်များကို ဂျင်အကောင့်ဖြင့် ဝင်ရောက်စေပြီး အသင်းဝင်ခွင့်စစ်ဆေးကာ အတန်းများကြိုတင်မှာယူစေပြီး သင့်ကိုယ်ပိုင်ဝက်ဘ်ဆိုက်တွင် အချိန်ဇယားပြသနိုင်ပါသည်။ စံ OpenID Connect၊ REST API အသေးစားနှင့် လက်မှတ်ထိုး webhook များ။
- OpenID Connect
- PKCE လိုအပ်သည်
- လက်မှတ်ထိုး webhook များ
01 · အမြန်စတင်ခြင်း
MoveMembers API အမြန်စတင်ခြင်း: ဝင်ရောက်၊ လဲလှယ်၊ ဖတ်ရှု။.
အသင်းဝင်များသည် ဂျင်အကောင့်ဖြင့် ဝင်ရောက်ပါသည်။ သင့်ဝက်ဘ်ဆိုက်သည် ၎င်းတို့၏ အသင်းဝင်နံပါတ်ပါသော လက်မှတ်ထိုးထားသည့်အဖြေကို ရရှိသဖြင့် မည်သည့် OIDC library မဆို အလုပ်လုပ်ပါသည်။
ခလုတ်ကို ထည့်ပါ
အသင်းဝင်ကို သူ့ဂျင်၏ လော့ဂ်အင်စာမျက်နှာသို့ ပို့ပါ။ အက်ပ်တိုင်းအတွက် PKCE လိုအပ်သည်၊ confidential ဖြစ်စေ public ဖြစ်စေ။
<!-- "Join Your Gym" -->
<a href="https://movemembers.com/oauth/authorize?client_id=app_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&response_type=code&scope=openid%20member_number%20profile%20email%20phone%20membership%20bookings%20field%3Avisitor_type&redirect_uri=https://yoursite.com/callback&state=…&nonce=…&code_challenge=…&code_challenge_method=S256&prompt=create"
style="display:inline-flex;align-items:center;gap:10px;padding:12px 20px;
border-radius:10px;background:#ffffff;color:#14161b;border:1px solid #e4e6ef;
font-family:inherit;
font-size:15px;font-weight:600;text-decoration:none">
Join Your Gym
</a>သင့်ဆာဗာတွင် ကုဒ်ကို လဲလှယ်ပါ
ဂျင်က လက်မှတ်ထိုးထားသော ID token ကို ရရှိပါမည် (ES256၊ ကီးများကို /oauth/jwks တွင်)။ ဤလဲလှယ်မှုကို စာမျက်နှာမှ မလုပ်ပါနှင့်၊ သင့် client secret လိုအပ်ပါသည်။
const { Issuer } = require("openid-client"); // any certified OIDC client works
const issuer = await Issuer.discover("https://movemembers.com");
const client = new issuer.Client({
client_id: "app_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
client_secret: process.env.APP_SECRET, // never hard-code this
redirect_uris: ["https://yoursite.com/callback"],
response_types: ["code"],
});
// codeVerifier is the one you generated before redirecting the member
const tokenSet = await client.callback(
"https://yoursite.com/callback",
params, // req.query, from the redirect
{ code_verifier: codeVerifier, state, nonce },
);
// tokenSet.claims() is verified against the gym's public keys at /oauth/jwks
const member = tokenSet.claims();Claims များကို ဖတ်ပါ
ဂျင်က စစ်ဆေးပြီး အသင်းဝင်က ခွင့်ပြုထားသည်များသာ ပါဝင်ပါသည်။ သင့်မှတ်တမ်းကို "sub" နှင့် ချိတ်ပါ၊ အီးမေးလ်လိပ်စာနှင့် ဘယ်တော့မှ မချိတ်ပါနှင့်။
{
"sub": "mbr_4Hq9kR2vLpXsT8nZ",
"member_number": "1042",
"name": "Nok Suwan",
"email": "nok@example.com",
"email_verified": true,
"phone_number": "+66812345678",
"membership": { "status": "active", "plan": "Monthly", "ends": "2026-11-01" },
"fields": { "visitor_type": "…" }
}04 · အသင်းဝင်စစ်ဆေးခြင်း
အသင်းဝင်နံပါတ်နှင့် အီးမေးလ်ကို အတူစစ်ဆေးပါ။.
ဆာဗာမှ ဆာဗာသို့ app token ဖြင့် (client_credentials, scope=lookup)။ ၎င်းတို့ကို လိပ်စာတွင် မထည့်ဘဲ body ထဲတွင်သာ ပို့ပါ၊ လိပ်စာများသည် ဆာဗာမှတ်တမ်းများထဲ ရောက်သွားတတ်သောကြောင့်ဖြစ်သည်။
အဖြေသည် အမြဲ 200 ဖြစ်ပြီး "active" အကွက်တစ်ခုတည်းပါသဖြင့် သင့်ဖောင်ကို သုံး၍ မည်သူသည် အသင်းဝင်ဖြစ်ကြောင်း မည်သူမျှ မသိနိုင်ပါ။ ပုံစံမမှန်သော body ကိုသာ 400 invalid_request ဖြင့် ဖြေပါသည်။
နည်းလမ်းများ
ဂျင် API အတွက် နမူနာနည်းလမ်းများ။.
ရေးသားသည့် endpoint တိုင်းသည် ဂျင်၏ကိုယ်ပိုင်အက်ပ်များနှင့် တူညီသောစည်းမျဉ်းများကို အသုံးပြုပါသည်။ ကြိုတင်မှာယူချိန်ကာလ၊ စောင့်ဆိုင်းစာရင်းနှင့် အစီအစဉ်စစ်ဆေးမှုတို့ဖြစ်သည်။
မှတ်တမ်းတစ်ခု ချိတ်ဆက်ပါ
သင့်ဆိုက်ရှိ မှတ်တမ်းတစ်ခုကို အသင်းဝင်တစ်ဦးနှင့် ချိတ်ပါ
ခွေး၊ လော့ကာ၊ ကား: "sub" ကို သင့်ကိုယ်ပိုင်မှတ်တမ်းတွင် foreign key အဖြစ် သိမ်းပါ၊ အီးမေးလ်ကို ဘယ်တော့မှ မသိမ်းပါနှင့်။ အခြေအနေကို နောက်မှ app token ဖြင့် ပြန်စစ်ပါ။
လမ်းညွှန်ကို ကြည့်ပါအတန်း စာရင်းသွင်းရန်
အသင်းဝင်ကိုယ်စား ကြိုတင်မှာယူခြင်း သို့မဟုတ် ပယ်ဖျက်ခြင်း
အချိန်ဇယားကို စာရင်းထုတ်ပြီး ၎င်းတို့၏ access token ဖြင့် ကြိုတင်မှာယူပါ။ "booking_refused" တွင် အသင်းဝင်နားလည်နိုင်သော အကြောင်းရင်း အမြဲပါသည်။ error.message ကို ပြပါ။
လမ်းညွှန်ကို ကြည့်ပါအချိန်ဇယားနှင့် စျေးနှုန်းများ
သင့်အချိန်ဇယားနှင့် စျေးနှုန်းများကို ပြပါ
အများသိ အချက်အလက်ဖြစ်ပြီး အသင်းဝင် လော့ဂ်အင် မလိုပါ။ scope=schedule ပါသော app token တစ်ခုဖြင့် /schedule နှင့် /offers ကို ဖတ်နိုင်သည်။
လမ်းညွှန်ကို ကြည့်ပါစစ်ဆေးပြီးနောက် အုပ်စုသတ်မှတ်ပါ
တတိယပါတီဖြင့် ကိုယ်ပိုင်အထောက်အထား စစ်ဆေးပြီး အုပ်စုတစ်ခု သတ်မှတ်ပါ
ဝန်ဆောင်မှုပေးသူသည် ရလဒ်ကို သင့်ဆာဗာသို့ ခေါ်ပို့ပါသည်၊ ဘရောက်ဇာစာမျက်နှာမှ ဘယ်တော့မှ မပို့ပါ။ အသင်းဝင်ရထိုက်သော အုပ်စုကိုသာ ပို့ပါ၊ ကိုယ်ရေးအချက်အလက်ကို ဘယ်တော့မှ မပို့ပါနှင့်။
လမ်းညွှန်ကို ကြည့်ပါ05 · Webhook များ
လက်မှတ်ထိုး webhook များ၊ ကုဒ်အကြောင်းအနည်းငယ်ဖြင့် စစ်ဆေးနိုင်သည်။.
member.connected, member.disconnected, member.status_changed, booking.created, booking.cancelled, payment.completed, member.group_changed။ 2xx မရပါက ၃ နာရီခန့်အတွင်း အများဆုံး ၅ ကြိမ် ပြန်ကြိုးစားပါသည်။
RAW body ပေါ်တွင် စစ်ဆေးပါ၊ ၅ မိနစ်ထက်ပိုဟောင်းသော လက်မှတ်ကို ပယ်ပါ၊ ထို့နောက် X-Webhook-Id ဖြင့် ထပ်နေသည်များကို ဖယ်ပါ။ လက်မှတ်ထိုးရန် secret ကို အက်ပ်၏ Webhooks တက်ဘ်တွင် တစ်ကြိမ်သာ ပြပါသည်။
10 · ကိုးကားချက်
MoveMembers API အဆုံးမှတ်အားလုံး.
နေရာတိုင်းတွင် JSON။ သင့်ဝက်ဘ်ဆိုက်မှ လာသောကြောင့် မည်သည့်အရာမျှ ကွဲပြားစွာ မလုပ်ဆောင်ပါ။
| နည်းလမ်း | လမ်းကြောင်း | လုပ်ဆောင်ပုံ | အထောက်အထားစိစစ်ခြင်း |
|---|---|---|---|
| GET | /.well-known/openid-configuration | Discovery စာတမ်း | none |
| GET | /oauth/jwks | အများသိ လက်မှတ်ထိုးကီးများ | none |
| GET | /oauth/authorize | လော့ဂ်အင် သို့မဟုတ် စာရင်းသွင်းမှု စတင်ခြင်း | none |
| POST | /oauth/token | ကုဒ်တစ်ခုလဲလှယ်ခြင်း၊ ပြန်လည်စတင်ခြင်း သို့မဟုတ် အက်ပ်တိုကင်ရယူခြင်း | အက်ပ်အထောက်အထားများ |
| GET | /oauth/userinfo | လော့ဂ်အင်ဝင်ထားသော အသင်းဝင်၏ claims | member, Bearer |
| POST | /oauth/revoke | တိုကင်တစ်ခုကို ပြန်လည်ရုပ်သိမ်းခြင်း | အက်ပ်အထောက်အထားများ |
| GET | /api/v1/me | လော့ဂ်အင်ဝင်ထားသော အသင်းဝင် | member, Bearer |
| GET | /api/v1/me/bookings | ၎င်းတို့၏ ဘွတ်ကင်များနှင့် အစီအစဉ်များ (ကျန်သောအတန်းများ၊ ရက်စွဲများ၊ ပေးရန်ပမာဏ) | member, Bearer |
| POST | /api/v1/bookings | သူ့ကိုယ်စား အတန်းတစ်ခု ဘွတ်ကင်လုပ်ခြင်း | member, Bearer |
| DELETE | /api/v1/bookings/{id} | ဘွတ်ကင်တစ်ခုကို ပယ်ဖျက်ခြင်း | member, Bearer |
| GET | /api/v1/members/{member_number} | နံပါတ်ဖြင့် အသင်းဝင်ကို စစ်ဆေးပါ | အက်ပ်၊ scope=lookup |
| POST | /api/v1/members/verify | အသင်းဝင်နံပါတ်နှင့် အီးမေးလ်ကို တွဲ၍ စစ်ဆေးခြင်း | အက်ပ်၊ scope=lookup |
| GET | /api/v1/schedule | အများသိ အတန်းအချိန်ဇယား | အက်ပ်၊ scope=schedule |
| GET | /api/v1/offers | အများသိရောင်းချနေသော အစီအစဉ်များနှင့် ထုတ်ကုန်များ | အက်ပ်၊ scope=schedule |
| GET | /api/v1/groups | ဤအက်ပ်က သတ်မှတ်နိုင်သော အုပ်စုများ | အက်ပ်၊ scope=groups |
| PUT | /api/v1/members/{member_number}/group | အသင်းဝင်တစ်ဦး၏ အုပ်စုကို သတ်မှတ်ခြင်း (သို့မဟုတ် ဖယ်ရှားခြင်း) | အက်ပ်၊ scope=groups |
GET /members/{member_number} နှင့် POST /members/verify သာ အသင်းဝင်၏ ခွင့်ပြုချက်မလိုဘဲ အလုပ်လုပ်ပြီး၊ အသင်းဝင်ခွင့် အသက်ဝင်နေ၊ မနေ ဆိုသည်ထက် ပိုမိုသော အချက်အလက် မပြန်ပေးပါ။
12 · တောင်းဆိုမှုကန့်သတ်ချက်များ
တောင်းဆိုမှုကန့်သတ်ချက်များ၊ တစ်မိနစ်လျှင် ရေတွက်သည်။.
ကန့်သတ်ချက်ကျော်လျှင် API သည် Retry-After header ပါသော 429 rate_limited ဖြင့် ဖြေပါသည်။ အမျိုးအစားတစ်ခုစီတွင် ကိုယ်ပိုင်ကန့်သတ်ချက်ရှိသဖြင့် ဖတ်ရှုမှုများသည် သင့်ကြိုတင်မှာယူမှုများကို မလောင်ပါ။
11 · အမှားများ
အမှားများ၊ နေရာတိုင်းတွင် ပုံစံတစ်မျိုးတည်း.
/api/v1 အမှားတိုင်းသည် { "error": { "code", "message", "request_id" } } ပုံစံဖြစ်သည်။ /oauth endpoint များသည် စံ OAuth ပုံစံအတိုင်း ရှိနေသောကြောင့် OAuth library များကို မပြင်ဘဲ သုံးနိုင်သည်။
| ကုဒ် | အဓိပ္ပာယ် |
|---|---|
| invalid_request | တောင်းဆိုမှု ပုံစံမမှန်ပါ: မသိသော သို့မဟုတ် စာလုံးပေါင်းမှားသော အကွက်၊ ပျောက်နေသော parameter၊ ကြီးလွန်းသော body။ |
| invalid_token | Bearer တိုကင် မရှိပါ၊ သက်တမ်းကုန်သွားပြီ သို့မဟုတ် ရုပ်သိမ်းခံထားရပါသည်။ |
| insufficient_scope | တိုကင်တွင် ဤ endpoint လိုအပ်သော scope မပါဝင်ပါ။ |
| capability_off | ဂျင်က သင့်အက်ပ်အတွက် ဤစွမ်းဆောင်ရည်ကို မဖွင့်ထားပါ။ |
| plan_required | ဂျင်၏အစီအစဉ်တွင် ချိတ်ဆက်အက်ပ်များ ယခု မပါဝင်ပါ။ ဘာမျှ မဖျက်ပါ၊ အဆင့်မြှင့်လိုက်သည်နှင့် ပြန်လာပါမည်။ |
| ဤသူနှင့် စကားဝိုင်း မရှိသေးပါ | ထိုအရင်းအမြစ် မရှိပါ (သို့မဟုတ် ဤဂျင်နှင့် မသက်ဆိုင်ပါ)။ |
| rate_limited | တောင်းဆိုမှု များလွန်းပါသည်။ Retry-After header တွင်ပါသော စက္ကန့်အရေအတွက်ကို စောင့်ပြီးမှ ပြန်ကြိုးစားပါ။ |
| booking_refused | ကြိုတင်မှာယူမှု စည်းမျဉ်းများက ဤတောင်းဆိုမှုကို ငြင်းပယ်ခဲ့သည်၊ message တွင် အကြောင်းရင်း ပါသည်။ membership_ ဖြင့် စသော message ဆိုသည်မှာ ကြိုတင်မှာယူမှု မဖန်တီးခဲ့ဟု ဆိုလိုသည်။ |
| noshow_blocked | booking_refused မက်ဆေ့ချ်: အဖွဲ့ဝင်သည် အားကစားခန်း၏ မလာခြင်းကန့်သတ်ချက်သို့ ရောက်သဖြင့် ယခုအချိန်တွင် အွန်လိုင်းဘွတ်ကင် မလုပ်နိုင်ပါ။ အမှားတွင် count၊ threshold နှင့် windowDays ပါဝင်သည်။ |
| age_restricted | booking_refused မက်ဆေ့ချ်: အဖွဲ့ဝင်သည် အတန်း၏ အနည်းဆုံးအသက်အောက် ဖြစ်နေသည်။ အမှားတွင် ageMin ပါဝင်သည်။ |
| guardian_required | booking_refused မက်ဆေ့ချ်: အဖွဲ့ဝင်သည် အရွယ်မရောက်သေးသူဖြစ်ပြီး အားကစားခန်းက ပရိုဖိုင်တွင် အုပ်ထိန်းသူ၏ အမည်နှင့် ဖုန်းနံပါတ် လိုအပ်သည်။ |
| guardian_consent_required | booking_refused မက်ဆေ့ချ်: အဖွဲ့ဝင်သည် အရွယ်မရောက်သေးသူဖြစ်ပြီး အားကစားခန်းက အုပ်ထိန်းသူ၏ သဘောတူညီချက် လိုအပ်သည်၊ မှတ်တမ်းမတင်ရသေးပါ။ |
| payment_required | ဤကြိုတင်မှာယူမှုကို ဦးစွာ ငွေပေးချေရန်လိုပါသည်။ အမှားတွင် အသင်းဝင်၏ငွေပေးချေမှုစာမျက်နှာဖြစ်သော payment_address ပါဝင်ပါသည်။ |
| no_consent | ထိုအသင်းဝင်သည် သင့်အက်ပ်နှင့် မချိတ်ဆက်ရသေးပါ။ |
| group_not_allowed | ထိုအုပ်စုကို ဂျင်က သင့်အက်ပ်အတွက် မဖွင့်ထားပါ။ |
request_id ကို X-Request-Id header အဖြစ်လည်း ပို့ပါသည်။ အကူအညီတောင်းသည့်အခါ ထည့်ပေးပါ၊ log ထဲတွင် သင့်ခေါ်ဆိုမှုကို ရှာတွေ့နိုင်ပါသည်။
မေးခွန်းများ
MoveMembers API အကြောင်း မေးခွန်းများ.
MoveMembers API သည် မည်သည့်ဝင်ရောက်မှုစံနှုန်းကို သုံးသနည်း။
အသင်းဝင်များသည် ခွင့်ပြုချက်မျက်နှာပြင်ကို အကြိမ်တိုင်း မြင်ရမည်လား။
ကျွန်ုပ်၏မှတ်တမ်းများကို အီးမေးလ်နှင့် ချိတ်သင့်သလား၊ sub နှင့် ချိတ်သင့်သလား။
အသင်းဝင်နံပါတ်နှင့် အီးမေးလ်သည် ကိုယ်ထူးကိုယ်ချင်း သက်သေပြရန် လုံလောက်ပါသလား။
အတန်းအတွက် အသင်းဝင်တွင် အစီအစဉ်မရှိလျှင် ဘာဖြစ်မည်နည်း။
မည်သည့် webhook အဖြစ်အပျက်များ ရှိသနည်း။
API ကို ကိုယ့်စက်ထဲတွင် မည်သို့စမ်းသပ်ရမည်နည်း။
သင့်ဂျင်မ်ပေါ်တွင် တည်ဆောက်ပါ။ ကိုယ်ပိုင်အကောင့်ဖြင့် စတင်ပါ။.
သင့်စတူဒီယိုကို ဖန်တီးပြီး အက်ပ်တစ်ခုနှင့် localhost ပြန်လာမည့်လိပ်စာကို မှတ်ပုံတင်ကာ လုပ်ငန်းစဉ်တစ်ခုလုံးကို စမ်းသပ်ပါ။
- Max ကို 14 ရက် အခမဲ့
- ခရက်ဒစ်ကတ် မလို
- အရောင်းဖုန်းခေါ်ဆိုမှု မရှိ
ဆက်ဖတ်ရန်
ဆက်စပ်သည်များ
feature
ဂျင်ဆော့ဖ်ဝဲ API အကျဉ်းချုပ်feature
အတန်းဘွတ်ကင်feature
အသင်းဝင် စီမံခန့်ခွဲမှုfeature
ဂျင်အလိုအလျောက်လုပ်ဆောင်မှုpricing
စျေးနှုန်းသတ်မှတ်ခြင်းနှိုင်းယှဉ်ချက်
လုပ်ဆောင်ချက်အားလုံး