API v1 · OpenID Connect
Ikonekta ang site mo sa gym mo.
Hayaang mag-sign in ang mga miyembro gamit ang gym account nila, mag-check ng membership, mag-book ng class at ipakita ang iskedyul sa sarili mong site. Standard na OpenID Connect, maliit na REST API at signed webhook.
- OpenID Connect
- Kailangan ang PKCE
- Signed webhook
01 · Mabilis na simula
Mabilis na simula sa MoveMembers API: sign in, exchange, basahin.
Nagsa-sign in ang mga miyembro gamit ang gym account nila. Makakatanggap ang site mo ng signed na sagot kasama ang member number nila, kaya gagana ang anumang OIDC library.
Idagdag ang button
Ipadala ang member sa sign-in page ng gym niya. Kailangan ang PKCE sa bawat app, confidential man o 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>Palitan ang code sa server mo
Makakatanggap ka ng ID token na pinirmahan ng gym (ES256, mga key sa /oauth/jwks). Huwag gawin ang exchange na ito mula sa isang page: kailangan nito ang client secret mo.
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();Basahin ang mga claim
Tanging ang na-check ng gym at inaprubahan ng miyembro. I-link ang record mo sa "sub", huwag sa email address.
{
"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 · Mag-check ng miyembro
I-check ang member number at email nang magkasama.
Server to server, gamit ang app token (client_credentials, scope=lookup). Ipadala ang mga ito sa body, hindi sa address: napupunta sa server logs ang address.
Laging 200 ang sagot na may isang field, "active", kaya walang makakagamit ng form mo para malaman kung sino ang miyembro. Ang maling anyo lang ng body ang sasagot ng 400 invalid_request.
Mga recipe
Mga recipe para sa gym API.
Ang bawat write endpoint ay gumagamit ng eksaktong parehong patakaran gaya ng sariling app ng gym: booking window, waitlist, pag-check ng plan.
Mag-link ng record
I-link ang isang tala sa site mo sa isang miyembro
Aso, locker, sasakyan: itago ang "sub" sa sarili mong record bilang foreign key, huwag ang email. I-check muli ang status mamaya gamit ang app token.
Tingnan ang gabayMag-book ng class
Mag-book o magkansela para sa miyembro
Ilista ang iskedyul, saka mag-book gamit ang access token nila. Ang "booking_refused" ay laging may dahilang maiintindihan ng miyembro: ipakita ang error.message.
Tingnan ang gabayIskedyul at presyo
Ipakita ang iskedyul at mga presyo mo
Pampublikong impormasyon, hindi kailangan ng sign-in ng miyembro. Isang app token na may scope=schedule ang nagbabasa ng /schedule at /offers.
Tingnan ang gabayI-verify, saka magtakda ng grupo
I-verify ang pagkakakilanlan gamit ang third party, saka magtakda ng grupo
Tinatawag ng provider ang server mo dala ang resulta, hindi kailanman isang browser page. Ipadala lang ang grupong nakuha ng miyembro, hindi kailanman ang data ng pagkakakilanlan.
Tingnan ang gabay05 · Webhook
Mga signed webhook, na nave-verify sa ilang linya.
member.connected, member.disconnected, member.status_changed, booking.created, booking.cancelled, payment.completed, member.group_changed. Uulitin hanggang 5 beses sa loob ng mga 3 oras kung walang 2xx.
I-verify sa RAW body, tanggihan ang anumang pinirmahan nang higit 5 minuto na ang nakalipas, saka i-deduplicate gamit ang X-Webhook-Id. Isang beses lang ipinapakita ang signing secret, sa Webhooks tab ng app.
10 · Reference
Lahat ng MoveMembers API endpoint.
JSON sa lahat ng dako. Walang kakaibang kilos dahil galing ito sa site mo.
| Paraan | Path | Ano ang ginagawa nito | Awtentikasyon |
|---|---|---|---|
| GET | /.well-known/openid-configuration | Discovery document | none |
| GET | /oauth/jwks | Mga public signing key | none |
| GET | /oauth/authorize | Magsimula ng sign-in o sign-up | none |
| POST | /oauth/token | Magpalit ng code, mag-refresh, o kumuha ng app token | mga app credential |
| GET | /oauth/userinfo | Ang mga claim ng naka-sign in na member | member, Bearer |
| POST | /oauth/revoke | Bawiin ang isang token | mga app credential |
| GET | /api/v1/me | Ang naka-sign in na member | member, Bearer |
| GET | /api/v1/me/bookings | Ang mga booking niya, at ang mga plan niya (natitirang class, petsa, halagang dapat bayaran) | member, Bearer |
| POST | /api/v1/bookings | Mag-book ng class para sa kanya | member, Bearer |
| DELETE | /api/v1/bookings/{id} | Mag-cancel ng booking | member, Bearer |
| GET | /api/v1/members/{member_number} | Suriin ang miyembro sa numero | app, scope=lookup |
| POST | /api/v1/members/verify | Suriin nang magkasama ang member number at email | app, scope=lookup |
| GET | /api/v1/schedule | Public na schedule ng class | app, scope=schedule |
| GET | /api/v1/offers | Mga plan at produktong ibinebenta sa publiko | app, scope=schedule |
| GET | /api/v1/groups | Mga grupong maitatakda ng app na ito | app, scope=groups |
| PUT | /api/v1/members/{member_number}/group | Magtakda (o mag-alis) ng grupo ng member | app, scope=groups |
Ang GET /members/{member_number} at POST /members/verify lang ang gumagana nang walang pahintulot ng miyembro, at wala silang ibinabalik maliban sa kung aktibo ang membership.
12 · Rate limit
Mga rate limit, binibilang kada minuto.
Kapag lumampas sa limit, sasagot ang API ng 429 rate_limited na may Retry-After header. May sariling budget ang bawat klase ng tawag, kaya hindi mauubos ang booking mo dahil sa dami ng pagbasa.
11 · Mga error
Mga error, iisang hugis saanman.
Ganito ang hitsura ng bawat error ng /api/v1: { "error": { "code", "message", "request_id" } }. Pinananatili ng mga /oauth endpoint ang karaniwang hugis ng OAuth, kaya gumagana ang mga OAuth library nang walang pagbabago.
| Code | Kahulugan |
|---|---|
| invalid_request | Mali ang pagkakabuo ng request: hindi kilala o maling tipa na field, kulang na parameter, o body na masyadong malaki. |
| invalid_token | Nawawala, nag-expire, o binawi na ang bearer token. |
| insufficient_scope | Wala sa token ang scope na kailangan ng endpoint na ito. |
| capability_off | Hindi pa ina-enable ng gym ang kakayahang ito para sa app mo. |
| plan_required | Hindi kasama sa plan ng gym ang mga nakakonektang app sa ngayon. Walang binubura; babalik ito sa sandaling mag-upgrade sila. |
| Hindi nahanap | Hindi umiiral ang resource na iyon (o hindi ito sa gym na ito). |
| rate_limited | Masyadong maraming request. Hintayin ang bilang ng segundo sa Retry-After header, saka subukan muli. |
| booking_refused | Tinanggihan ng mga patakaran sa booking ang request na ito; ipinapaliwanag ng message kung bakit. Kapag nagsisimula sa membership_ ang message, walang nagawang booking. |
| noshow_blocked | Mensaheng booking_refused: naabot ng miyembro ang limitasyon ng gym sa no-show at hindi muna makakapag-book online. Dala ng error ang count, threshold at windowDays. |
| age_restricted | Mensaheng booking_refused: wala pa sa minimum na edad ng class ang miyembro. Dala ng error ang ageMin. |
| guardian_required | Mensaheng booking_refused: menor de edad ang miyembro at kailangan ng gym ng pangalan at telepono ng guardian sa file. |
| guardian_consent_required | Mensaheng booking_refused: menor de edad ang miyembro at kailangan ng gym ang pahintulot ng guardian, na hindi pa naitatala. |
| payment_required | Kailangan munang bayaran ang booking na ito. Kasama sa error ang payment_address, ang payment page ng miyembro. |
| no_consent | Hindi pa nakakakonekta ang member na iyon sa app mo. |
| group_not_allowed | Ang grupong iyon ay hindi isa sa mga in-enable ng gym para sa app mo. |
Ipinapadala rin ang request_id bilang X-Request-Id header: banggitin ito kapag humingi ka ng tulong, mahahanap nito ang tawag mo sa log.
Mga tanong
Mga tanong tungkol sa MoveMembers API.
Anong sign-in standard ang gamit ng MoveMembers API?
Makikita ba ng mga miyembro ang consent screen sa bawat pagkakataon?
Sa email ba o sa sub ko dapat i-link ang mga record ko?
Sapat na ba ang member number at email para patunayan ang pagkakakilanlan?
Ano ang mangyayari kapag walang plan ang miyembro para sa isang class?
Anong mga webhook event ang available?
Paano ko susubukan ang API sa local?
Bumuo sa ibabaw ng gym mo. Magsimula sa sarili mong account.
Gawin ang studio mo, magrehistro ng app at localhost return address, at subukan ang buong daloy.
- 14 araw ng Max, libre
- Walang credit card
- Walang sales call
Magpatuloy sa pagbabasa
Kaugnay
feature
Pag-book ng classfeature
Member managementfeature
Gym automationpricing
PresyoFeature
Lahat ng feature