API v1 · OpenID Connect
Подключите сайт к вашему залу.
Пусть участники входят на ваш сайт через аккаунт зала, проверяют абонемент, записываются на занятия и видят расписание. Стандартный OpenID Connect, компактный REST API и подписанные вебхуки.
- OpenID Connect
- PKCE обязателен
- Подписанные вебхуки
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-токен, подписанный залом (ES256, ключи по адресу /oauth/jwks). Никогда не выполняйте этот обмен со страницы: для него нужен секрет клиента.
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 · Проверка участника
Проверяйте номер участника и e-mail вместе.
Сервер к серверу, с токеном приложения (client_credentials, scope=lookup). Передавайте их в теле запроса, а не в адресе: адрес попадает в журналы сервера.
Ответ всегда 200 с одним полем "active", поэтому через вашу форму нельзя выяснить, кто является участником. Ошибкой 400 invalid_request отвечает только некорректное тело запроса.
Рецепты
Рецепты для API зала.
Каждый метод записи использует те же правила, что и приложения самого зала: окна записи, листы ожидания, проверку тарифов.
Привяжите запись
Привязать запись на вашем сайте к клиенту
Собака, шкафчик, автомобиль: храните "sub" в своей записи как внешний ключ, а не e-mail. Статус можно позже перепроверить с токеном приложения.
Открыть руководствоЗаписаться на занятие
Запись или отмена от имени участника
Получите расписание, затем запишите участника с его токеном доступа. У ответа "booking_refused" всегда есть понятная участнику причина: показывайте error.message.
Открыть руководствоРасписание и цены
Покажите расписание и цены
Публичная информация, вход участника не требуется. Одного токена приложения со scope=schedule достаточно, чтобы читать /schedule и /offers.
Открыть руководствоПроверьте, затем назначьте группу
Подтвердить личность через третью сторону, затем задать группу
Провайдер передаёт результат на ваш сервер, а не на страницу в браузере. Отправляйте только группу, которую заслужил участник, и никаких персональных данных.
Открыть руководство05 · Вебхуки
Подписанные вебхуки, проверка в несколько строк.
member.connected, member.disconnected, member.status_changed, booking.created, booking.cancelled, payment.completed, member.group_changed. Если ответа 2xx нет, повторная отправка до 5 раз в течение примерно 3 часов.
Проверяйте подпись по необработанному (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 | Проверить номер клиента и e-mail вместе | приложение, 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 с заголовком Retry-After. У каждого типа вызовов свой лимит, поэтому интенсивное чтение не расходует лимит на записи.
11 · Ошибки
Ошибки в одном формате везде.
Каждая ошибка /api/v1 выглядит так: { "error": { "code", "message", "request_id" } }. Конечные точки /oauth сохраняют стандартный формат OAuth, поэтому библиотеки OAuth работают без доработок.
| Код | Значение |
|---|---|
| invalid_request | Запрос некорректен: неизвестное поле или опечатка в нём, отсутствует параметр либо слишком большое тело запроса. |
| invalid_token | Токен доступа отсутствует, просрочен или отозван. |
| insufficient_scope | У токена нет области доступа, нужной этому эндпоинту. |
| capability_off | Зал не включил эту возможность для вашего приложения. |
| plan_required | Сейчас тариф зала не включает подключённые приложения. Ничего не удаляется: всё вернётся, как только зал перейдёт на более высокий тариф. |
| not_found | Такого ресурса нет (или он не принадлежит этому залу). |
| rate_limited | Слишком много запросов. Подождите столько секунд, сколько указано в заголовке 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 также приходит в заголовке X-Request-Id: назовите его, когда обращаетесь за помощью, и мы найдём ваш вызов в журнале.
Вопросы
Вопросы об API MoveMembers.
Какой стандарт входа использует API MoveMembers?
Будут ли участники видеть экран согласия каждый раз?
К чему привязывать записи: к e-mail или к sub?
Достаточно ли номера участника и e-mail, чтобы подтвердить личность?
Что будет, если у участника нет подходящего тарифа для занятия?
Какие события вебхуков доступны?
Как протестировать API локально?
Стройте на основе вашего зала. Начните со своего аккаунта.
Создайте студию, зарегистрируйте приложение и адрес возврата localhost и проверьте весь сценарий.
- 14 дн. тарифа Max бесплатно
- Без банковской карты
- Без звонка продавца
Читать дальше
Похожее
feature
Обзор API программы для залаfeature
Запись на занятиеfeature
Управление клиентамиfeature
Автоматизация залаpricing
ЦеныФункция
Все функции