API v1 · OpenID Connect
ភ្ជាប់គេហទំព័ររបស់អ្នក ទៅកន្លែងហាត់ប្រាណរបស់អ្នក។.
ឱ្យសមាជិកចូលដោយប្រើគណនីកន្លែងហាត់ប្រាណរបស់ពួកគេ ពិនិត្យសមាជិកភាព កក់ថ្នាក់ និងបង្ហាញកាលវិភាគលើគេហទំព័រផ្ទាល់ខ្លួនរបស់អ្នក។ OpenID Connect ស្តង់ដារ REST API តូចមួយ និង webhook ដែលមានហត្ថលេខា។
- OpenID Connect
- តម្រូវឱ្យមាន PKCE
- Webhook ដែលមានហត្ថលេខា
01 · ចាប់ផ្តើមរហ័ស
ចាប់ផ្តើមរហ័សជាមួយ API របស់ MoveMembers៖ ចូល ផ្លាស់ប្តូរ អាន។.
សមាជិកចូលដោយប្រើគណនីកន្លែងហាត់ប្រាណរបស់ពួកគេ។ គេហទំព័ររបស់អ្នកទទួលបានចម្លើយដែលមានហត្ថលេខា ជាមួយលេខសមាជិករបស់ពួកគេ ដូច្នេះបណ្ណាល័យ OIDC ណាក៏ប្រើបាន។
បន្ថែមប៊ូតុង
ផ្ញើសមាជិកទៅទំព័រចូលគណនីនៃកន្លែងហាត់ប្រាណរបស់ពួកគេ។ PKCE ត្រូវបានតម្រូវសម្រាប់គ្រប់កម្មវិធី ទាំងសម្ងាត់ និងសាធារណៈ។
<!-- "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();អានការអះអាង
មានតែអ្វីដែលកន្លែងហាត់ប្រាណបានពិនិត្យ និងសមាជិកបានយល់ព្រមប៉ុណ្ណោះ។ ភ្ជាប់កំណត់ត្រារបស់អ្នកទៅ "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)។ ផ្ញើពួកវានៅក្នុងតួ មិនមែននៅក្នុងអាសយដ្ឋានទេ៖ អាសយដ្ឋានទៅបញ្ចប់ក្នុងកំណត់ហេតុម៉ាស៊ីនមេ។
ចម្លើយគឺ 200 ជានិច្ច ជាមួយវាលមួយគឺ "active" ដូច្នេះគ្មាននរណាអាចប្រើទម្រង់របស់អ្នកដើម្បីដឹងថាអ្នកណាជាសមាជិកទេ។ មានតែខ្លឹមសារដែលមិនត្រឹមត្រូវប៉ុណ្ណោះ ដែលឆ្លើយ 400 invalid_request។
រូបមន្តគំរូ
រូបមន្តប្រើ API កន្លែងហាត់ប្រាណ។.
ចំណុចបញ្ចប់សរសេរទាំងអស់ ហៅច្បាប់ដូចគ្នាបេះបិទនឹងកម្មវិធីរបស់កន្លែងហាត់ប្រាណ៖ រយៈពេលកក់ បញ្ជីរង់ចាំ ការត្រួតពិនិត្យគម្រោង។
ភ្ជាប់កំណត់ត្រា
ភ្ជាប់កំណត់ត្រានៅលើគេហទំព័ររបស់អ្នកទៅសមាជិកម្នាក់
ឆ្កែ ទូរក្សាទុក ឬឡាន៖ រក្សាទុក "sub" នៅលើកំណត់ត្រារបស់អ្នកជា foreign key កុំប្រើអ៊ីមែល។ ពិនិត្យស្ថានភាពម្តងទៀតនៅពេលក្រោយ ដោយ app token។
មើលការណែនាំកក់ថ្នាក់
កក់ ឬលុបចោលជំនួសសមាជិក
រាយកាលវិភាគ រួចកក់ដោយ access token របស់ពួកគេ។ "booking_refused" តែងតែមានមូលហេតុដែលសមាជិកយល់៖ បង្ហាញ error.message។
មើលការណែនាំកាលវិភាគ និងតម្លៃ
បង្ហាញកាលវិភាគ និងតម្លៃរបស់អ្នក
ព័ត៌មានសាធារណៈ មិនបាច់ឱ្យសមាជិកចូលគណនីទេ។ ថូខឹនកម្មវិធីមួយដែលមាន scope=schedule អាន /schedule និង /offers។
មើលការណែនាំផ្ទៀងផ្ទាត់ រួចកំណត់ក្រុម
ផ្ទៀងផ្ទាត់អត្តសញ្ញាណជាមួយភាគីទីបី បន្ទាប់មកកំណត់ក្រុម
អ្នកផ្តល់សេវាហៅម៉ាស៊ីនមេរបស់អ្នកជាមួយលទ្ធផល មិនមែនតាមទំព័រកម្មវិធីរុករកឡើយ។ ផ្ញើតែក្រុមដែលសមាជិកទទួលបាន កុំផ្ញើទិន្នន័យអត្តសញ្ញាណ។
មើលការណែនាំ05 · Webhooks
Webhook ដែលមានហត្ថលេខា ផ្ទៀងផ្ទាត់ក្នុងប៉ុន្មានបន្ទាត់។.
member.connected, member.disconnected, member.status_changed, booking.created, booking.cancelled, payment.completed, member.group_changed។ ព្យាយាមម្តងទៀតរហូតដល់ 5 ដង ក្នុងរយៈពេលប្រហែល 3 ម៉ោង ប្រសិនបើគ្មាន 2xx។
ផ្ទៀងផ្ទាត់លើខ្លឹមសារ RAW បដិសេធអ្វីដែលចុះហត្ថលេខាលើសពី 5 នាទីមុន រួចលុបការស្ទួនតាម X-Webhook-Id។ សម្ងាត់ចុះហត្ថលេខាបង្ហាញតែម្តង នៅផ្ទាំង Webhooks របស់កម្មវិធី។
10 · ឯកសារយោង
ចំណុចបញ្ចប់ API ទាំងអស់របស់ MoveMembers.
JSON គ្រប់ទីកន្លែង។ គ្មានអ្វីដំណើរការខុសគ្នា ដោយសារវាមកពីគេហទំព័ររបស់អ្នកទេ។
| វិធីសាស្ត្រ | ផ្លូវ | អ្វីដែលវាធ្វើ | ការផ្ទៀងផ្ទាត់ |
|---|---|---|---|
| GET | /.well-known/openid-configuration | ឯកសារស្វែងរក | none |
| GET | /oauth/jwks | កូនសោចុះហត្ថលេខាសាធារណៈ | none |
| GET | /oauth/authorize | ចាប់ផ្តើមការចូលគណនី ឬចុះឈ្មោះ | none |
| POST | /oauth/token | ប្តូរកូដ ធ្វើឲ្យស្រស់ ឬទទួលថូខឹនកម្មវិធី | អត្តសញ្ញាណកម្មវិធី |
| GET | /oauth/userinfo | ការអះអាងរបស់សមាជិកដែលបានចូលគណនី | 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 ឆ្លើយ 429 rate_limited ជាមួយ header Retry-After។ ប្រភេទនីមួយៗមានកូតាផ្ទាល់ខ្លួន ដូច្នេះការអានច្រើនមិនប្រើអស់កូតាការកក់របស់អ្នកទេ។
11 · កំហុស
កំហុស ទម្រង់តែមួយគ្រប់ទីកន្លែង.
រាល់កំហុស /api/v1 មានរូបរាងដូច { "error": { "code", "message", "request_id" } }។ ចំណុចបញ្ចប់ /oauth រក្សារូបរាង OAuth ស្តង់ដារ ដូច្នេះបណ្ណាល័យ OAuth ដំណើរការដូចដើម។
| លេខកូដ | អត្ថន័យ |
|---|---|
| invalid_request | សំណើមិនត្រឹមត្រូវ៖ វាលមិនស្គាល់ ឬវាយខុស ខ្វះប៉ារ៉ាម៉ែត្រ ឬខ្លឹមសារធំពេក។ |
| invalid_token | ថូខឹន Bearer បាត់ ផុតកំណត់ ឬត្រូវបានដកចេញ។ |
| insufficient_scope | ថូខឹនមិនមានវិសាលភាពដែលចំណុចបញ្ចប់នេះត្រូវការទេ។ |
| capability_off | កន្លែងហាត់ប្រាណមិនបានបើកសមត្ថភាពនេះសម្រាប់កម្មវិធីរបស់អ្នកទេ។ |
| plan_required | គម្រោងរបស់កន្លែងហាត់ប្រាណមិនរួមបញ្ចូលកម្មវិធីដែលបានភ្ជាប់នៅពេលនេះទេ។ គ្មានអ្វីត្រូវបានលុបទេ វានឹងត្រឡប់មកវិញភ្លាមៗនៅពេលពួកគេដំឡើងកម្រិត។ |
| គ្មានការសន្ទនាជាមួយបុគ្គលនេះទេ | ធនធាននោះមិនមានទេ (ឬមិនមែនជារបស់កន្លែងហាត់ប្រាណនេះ)។ |
| rate_limited | សំណើច្រើនពេក។ រង់ចាំចំនួនវិនាទីក្នុង header Retry-After រួចព្យាយាមម្តងទៀត។ |
| booking_refused | ច្បាប់កក់បានបដិសេធសំណើនេះ ហើយ message ពន្យល់មូលហេតុ។ សារដែលចាប់ផ្ដើមដោយ membership_ មានន័យថាមិនមានការកក់ណាត្រូវបានបង្កើតទេ។ |
| 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 ក៏ត្រូវបានផ្ញើជា header X-Request-Id ដែរ៖ សូមបញ្ជាក់វានៅពេលស្នើសុំជំនួយ វាជួយរកការហៅរបស់អ្នកក្នុងកំណត់ហេតុ។
សំណួរ
សំណួរអំពី API របស់ MoveMembers.
តើ API របស់ MoveMembers ប្រើស្តង់ដារចូលប្រើអ្វី?
តើសមាជិកនឹងឃើញអេក្រង់យល់ព្រមរាល់ពេលឬទេ?
តើខ្ញុំគួរភ្ជាប់កំណត់ត្រារបស់ខ្ញុំទៅអ៊ីមែល ឬទៅ sub?
តើលេខសមាជិក និងអ៊ីមែលគ្រប់គ្រាន់ដើម្បីបញ្ជាក់អត្តសញ្ញាណឬទេ?
តើមានអ្វីកើតឡើងនៅពេលសមាជិកគ្មានគម្រោងសម្រាប់ថ្នាក់?
តើមាន webhook event អ្វីខ្លះ?
តើខ្ញុំសាកល្បង API ក្នុងម៉ាស៊ីនខ្ញុំដោយរបៀបណា?
បង្កើតលើកន្លែងហាត់របស់អ្នក។ ចាប់ផ្តើមជាមួយគណនីផ្ទាល់ខ្លួន។.
បង្កើតស្ទូឌីយោរបស់អ្នក ចុះឈ្មោះកម្មវិធី និងអាសយដ្ឋានត្រឡប់ localhost ហើយសាកល្បងដំណើរការទាំងមូល។
- Max ឥតគិតថ្លៃ 14 ថ្ងៃ
- គ្មានកាតឥណទាន
- គ្មានការហៅទូរសព្ទលក់
អានបន្ត