Создавање и управување со API клучеви

API клучот му овозможува на вашиот софтвер, или на програмер со кој соработувате, да чита и запишува податоци на вашата теретана преку REST API на FitManager. Секој клуч припаѓа на една теретана и секое барање направено со него ги гледа само записите на таа теретана.

Пред да започнете#

• Потребна ви е дозволата settings.manage. Сопствениците на теретаната ја имаат. Вработените ја гледаат страницата само ако им е доделена во дозволите на персоналот.
• Вашиот пакет мора да вклучува API пристап. Страницата е во Поставки > Интеграции > API интеграција, или отворете ги Интеграциите директно.
• Чувајте го клучот како лозинка. Секој што го има може да работи со податоците на теретаната преку API.

Создадете клуч#

Секое барање до REST API оди на оваа основна адреса.

Дајте му име на клучот што кажува која алатка ќе го користи.

Изберете Продукциско за вистинските податоци. За тест клуч прво ви треба тест околина.

Кликнете Создади клуч.

Копирајте го целиот клуч сега и чувајте го на безбедно место. Никогаш повеќе не се прикажува.

Кликнете Готово откако ќе го зачувате.

Клучот е наведен според префиксот, со времето на последна употреба. Од тука го заменувате или повлекувате.

Следно

Готово

Тоа е сè. Можете да го повторите во секое време.

Почни од почеток

1. Секое барање до REST API оди на оваа основна адреса.

2. Дајте му име на клучот што кажува која алатка ќе го користи.

3. Изберете Продукциско за вистинските податоци. За тест клуч прво ви треба тест околина.

4. Кликнете Создади клуч.

5. Копирајте го целиот клуч сега и чувајте го на безбедно место. Никогаш повеќе не се прикажува.

6. Кликнете Готово откако ќе го зачувате.

7. Клучот е наведен според префиксот, со времето на последна употреба. Од тука го заменувате или повлекувате.

1. Чекор 1: Секое барање до REST API оди на оваа основна адреса.
2. Чекор 2: Дајте му име на клучот што кажува која алатка ќе го користи.
3. Чекор 3: Изберете Продукциско за вистинските податоци. За тест клуч прво ви треба тест околина.
4. Чекор 4: Кликнете Создади клуч.
5. Чекор 5: Копирајте го целиот клуч сега и чувајте го на безбедно место. Никогаш повеќе не се прикажува.
6. Чекор 6: Кликнете Готово откако ќе го зачувате.
7. Чекор 7: Клучот е наведен според префиксот, со времето на последна употреба. Од тука го заменувате или повлекувате.

1. Одете во Поставки > Интеграции > API интеграција.
2. Во картичката API клучеви, внесете Име на клучот што кажува која алатка ќе го користи, на пример „Интеграција со веб-страна“. Името служи само за вас.
3. Изберете Околина: Продукциско работи со вистинските податоци, Тест работи само со тест околината (погледнете подолу).
4. Кликнете Создади клуч.
5. Жолто поле со наслов Копирајте го вашиот API клуч сега го прикажува целиот клуч. Кликнете Копирај и зачувајте го на безбедно место, на пример во менаџер за лозинки или во поставките на вашиот сервер.
6. Кликнете Готово. Целиот клуч никогаш повеќе не се прикажува. FitManager чува само отпечаток од него, па ни поддршката не може да го врати.

Клучот потоа се појавува во списокот со Префикс (првите знаци, за да ги разликувате клучевите), Околина, кога е Последно користен и Статус.

Продукциски и тест клучеви#

Тест клучот никогаш не може да допре продукциски записи, а продукцискиот клуч никогаш не стигнува до тест околината. Ако се обидете да создадете тест клуч пред да имате тест околина, ќе ја видите пораката „Прво создадете тест околина за да создадете тест клуч.“

Создадете тест околина#

1. Во картичката Тест околина, кликнете Создади тест околина.
2. FitManager создава празна копија од вашата теретана со име „{вашата теретана} (Sandbox)“, со еден објект и на истиот пакет. Картичката потоа покажува Подготвена.
3. Создадете клуч со Околина поставена на Тест.

Тест околината почнува празна: нема членови, членарини ни производи сè додека вашата интеграција не ги создаде преку API. Една теретана може да има само една тест околина.

Автентикација на барањата#

Испратете го клучот како Bearer токен во заглавието Authorization. Основната адреса е прикажана горе десно во картичката API клучеви како Основна адреса, обично https://fitmanager.com/api/v1.

curl https://fitmanager.com/api/v1/members?per_page=10 \
  -H "Authorization: Bearer fm_live_vasiot_kluc" \
  -H "Accept: application/json"

Ако вашата алатка не може да постави Bearer токен, клучот може да го испратите и во заглавието X-Api-Key. Секогаш испраќајте Accept: application/json за грешките да се враќаат како JSON.

Ограничување на барањата#

Секој клуч може да направи 120 барања во минута. Ако го надминете ова, API одговара со 429 Too Many Requests и заглавие Retry-After што кажува колку секунди да почекате. Адресите за уредите што ги користи FitManager Control имаат посебно, повисоко ограничување.

Безбедно повторување#

За барањата POST, PUT и PATCH може да додадете заглавие Idempotency-Key со единствена вредност (UUID е добар избор). Ако истото барање со истата вредност пристигне повторно во рок од 24 часа, API го враќа првиот одговор, со заглавие Idempotency-Replayed: true, наместо да создаде дупликат.

Заменете клуч#

Замената го менува клучот без прекин во работата. Стариот клуч работи уште 24 часа, за да имате време да ја префрлите интеграцијата.

1. Создадете нов клуч и ставете го во интеграцијата.
2. На стариот клуч кликнете Замени и потврдете.
3. Статусот на стариот клуч станува Истекува, со преостанатото време. Потоа сам престанува да работи, а копчето Замени исчезнува од него.

Повлечете клуч#

Кликнете Повлечи на клучот и потврдете. Престанува да работи веднаш и секоја интеграција што го користи од тој момент добива грешка 401. Ако мислите дека клучот протекол, веднаш повлечете го и создадете нов.

Решавање проблеми#

Секое барање враќа 401 „Invalid or missing API key“#

Клучот недостасува, погрешно е внесен, повлечен е или му поминал рокот по замената. Тест клуч за теретана без тест околина исто така не успева на ист начин. Проверете го Статусот на клучот во списокот и дали сте го копирале целиот, заедно со почетокот fm_live_ или fm_test_.

403 „This gym does not have API access enabled.“#

Вашиот пакет повеќе не вклучува API пристап, на пример по преминување на понизок пакет. Претходно создадените клучеви не работат додека функцијата не се врати. Погледнете Што е вклучено во мојот пакет.

402 „payment_required“#

Претплатата за FitManager не е платена и рокот за плаќање поминал. API и уредите продолжуваат да работат штом ќе се плати фактурата. Погледнете Пропуштени плаќања.

Го изгубив клучот#

Не може повторно да се прикаже. Создадете нов клуч, ажурирајте ја интеграцијата, па повлечете го стариот.