Преглед на REST API
Што опфаќа REST API на FitManager, како работат одговорите, страничењето и грешките и каде да ја најдете целосната OpenAPI спецификација.
REST API на FitManager му овозможува на вашиот софтвер да работи со членовите, пакетите, влезовите, производите и продажбите на вашата теретана. Оваа страница е мапа на она што е достапно. За да добиете клуч, почнете со API клучеви.
Основи
| Основна адреса | https://fitmanager.com/api/v1 (прикажана како Основна адреса во картичката API клучеви) |
| Автентикација | Authorization: Bearer fm_live_... или X-Api-Key: fm_live_... |
| Формат | JSON во двата правци. Испраќајте Accept: application/json |
| Ограничување | 120 барања во минута по клуч, над тоа 429 со Retry-After |
| Опсег | Една теретана по клуч. Записите од други теретани враќаат 404 |
| Повторувања | Додадете заглавие Idempotency-Key на запишувањата за повторувањето да не се изврши двапати (се чува 24 часа) |
Адреси
| Метод и патека | Што прави | Филтри |
|---|---|---|
GET /members |
Список на членови, од најнов | status, search (име и е-пошта) |
GET /members/{id} |
Еден член | |
POST /members |
Создава член. first_name и last_name се задолжителни; email, phone, gender, date_of_birth, city, country, status (active или inactive) и facility_id се по избор |
|
PUT или PATCH /members/{id} |
Ги ажурира полињата што ги испраќате | |
GET /memberships, GET /memberships/{id} |
Вашите пакети за членарина | |
GET /membership-subscriptions, GET /membership-subscriptions/{id} |
Пакети за претплата што се обновува | |
GET /attendance (и /access-logs) |
Влезови и записи од пристапот | member_id, status, from, to |
GET /products, GET /products/{id} |
Производи | status |
GET /purchases, GET /purchases/{id} |
Продажби | member_id, payment_status |
GET /statistics |
Број на членови, активни членарини, објекти и платениот приход за овој месец | |
POST /webhook-deliveries/{id}/redeliver |
Повторно испраќа webhook испорака | |
POST /import/{entity}, GET /import/status |
Масовен увоз од друг систем за теретани |
Кога создавате член без facility_id, тој оди во вашиот прв објект.
Списоци и страничење
Адресите за списоци враќаат 25 записи по страница. Користете per_page (до 100) и page за да се движите низ нив:
curl "https://fitmanager.com/api/v1/members?status=active&per_page=100&page=2" \
-H "Authorization: Bearer fm_live_vasiot_kluc" \
-H "Accept: application/json"
Одговорот ги има записите во data, врските до страниците во links (first, last, prev, next) и бројките во meta (current_page, last_page, per_page, total). Барајте ја links.next сè додека не стане null.
Секој запис има поле object, на пример "object": "member", за да ги разликувате типовите.
Грешки
Грешките за клучот, пакетот и плаќањето (401, 402, 403) се враќаат како JSON со објект error:
{ "error": { "type": "unauthorized", "message": "Invalid or missing API key." } }
| Статус | Значење |
|---|---|
401 |
Клучот недостасува, погрешен е, повлечен е или му истекол рокот |
402 |
Претплатата за FitManager не е платена и рокот за плаќање поминал |
403 |
Вашиот пакет не ја вклучува функцијата што ѝ треба на оваа адреса |
404 |
Записот не постои или припаѓа на друга теретана |
422 |
Проверката не успеа. Одговорот има message и проблематичните полиња во errors |
429 |
Премногу барања. Почекајте онолку секунди колку што пишува во Retry-After |
Увоз од друг систем
POST /import/{entity} пренесува податоци од претходен систем за теретани во серии до 500 редови. Испраќајте ги ентитетите по овој редослед: plans, members, memberships, attendance, access_logs, products, purchases. Секој ред има legacy_id, ID-то што го имал во стариот систем, па веќе увезените редови се прескокнуваат и серијата може безбедно да се испрати повторно. GET /import/status покажува колку редови од секој вид пристигнале. За увоз од табела, погледнете Увоз на членови.
OpenAPI спецификацијата
Целосната спецификација, со секое поле и одговор, е OpenAPI 3 датотека (openapi.yaml). Сè уште не е објавена на јавна адреса. За да ја добиете тековната верзија за вашиот програмер, отворете тикет за поддршка и побарајте ја спецификацијата на FitManager API. Датотеката може да ја вчитате во алатки како Postman или Swagger UI за да го истражувате и тестирате API.
Други API
Site API за веб-страници
Ако градите своја веб-страница за теретаната, користете го Site API. Користи јавен клуч што е безбеден за код во прелистувачот и ги покажува само работите што вашата јавна веб-страница веќе ги прикажува, како пакети, часови и објави на блогот, плус формите за контакт и билтен. Погледнете Website API.
Адреси за уредите
FitManager Control, Windows апликацијата на вашата рецепција, користи свои адреси под истата /api/v1 адреса: проверка на вратите и ѕвончето, задачи за фискалниот принтер, задачи за картичниот терминал и нарачки од киоскот. Користат исти API клучеви, но имаат повисоко ограничување и се дозволени според функциите за уредите во вашиот пакет, а не според API пристапот. Наменети се само за FitManager Control, не за вашите интеграции. Погледнете FitManager Control.
Webhooks
За да ве известуваме за промените наместо постојано да проверувате, поставете webhooks.
Дали оваа страница ви помогна?
Поврзани статии
Сè уште имате проблем?
Пишете ни и ќе ви одговориме во рок од еден работен ден.