Egy API-kulcs révén a saját szoftvere a REST API-n keresztül kommunikálhat a platformjával, például tagok lekéréséhez, valaki beiratkoztatásához egy kurzusba vagy egy WordPress-webhely összekötéséhez. Minden kulcs egy program titkos jelszava, ezért kulcsonként dönti el, mit tehet, és bármikor lecserélheti vagy törölheti.
Ki kezelheti az API-kulcsokat?
Az API a beállítások menüjének Integrációk és API blokkjában található. A szerepkörének a Platformbeállítások frissítése mellett az API-kulcsok kezelése jogosultság is kell. Ez a jogosultság egyéni szerepkörhöz soha nem adható, így itt csak a beépített Tulajdonos és Adminisztrátor szerepkör dolgozhat. Ugyanez a jogosultság nyitja meg az OAuth alkalmazások és az Egyszeri bejelentkezés oldalt is.
Az API-hozzáférés a csomagjától függ. Ha a csomagja nem tartalmazza, az oldalon ez áll: „Az API-hozzáférés minden fizetős csomagban benne van. Váltson csomagot, hogy API-kulcsokat hozhasson létre.”, mellette a Csomag módosítása, az Új API-kulcs pedig letiltva marad. A már meglévő kulcsokat az API addig elutasítja, amíg a csomag újra nem tartalmazza.
Kulcs létrehozása
Kattintson az Új API-kulcs gombra. Megnyílik az API-kulcs létrehozása ablak.
- Adjon meg egy Kulcs neve értéket, amelyből később kiderül, ki használja a kulcsot, például az eszköz vagy a weboldal, amelyhez tartozik. A név kötelező.
- Döntse el, mit tehet a kulcs. Egy új kulcs teljes hozzáféréssel indul, így minden jogosultság ki van jelölve.
- Kattintson a Létrehozás gombra.
A kulcs korlátozásához kattintson a Korlátozás meghatározott jogosultságokra lehetőségre. Ekkor minden jogosultság kijelölése megszűnik, és Ön választja ki a szükségeseket. A jogosultságok területenként csoportosítva jelennek meg, például Tagok, Csoportok, Tanfolyamok vagy Fizetések, és minden terület olyan műveleteket sorol fel rövid leírással, mint a Megtekintés vagy a Kezelés. Az Összes kijelölése és az Összes kijelölés megszüntetése egyszerre egy egész területet kapcsol. Egy számláló mutatja, hány jogosultsága van a kulcsnak. Egy kulcsnak legalább egy jogosultság kell, a Visszaállítás teljes hozzáférésre pedig újra mindet kijelöli.
Miután a Létrehozás gombra kattintott, Az Ön új API-kulcsa ablak egyszer mutatja a teljes kulcsot. Másolja ki, és tárolja biztonságos helyen. A lista ezután csak az utolsó négy karaktert mutatja, és senki sem jelenítheti meg újra a teljes kulcsot.
Kulcs használata
A lista feletti API-dokumentáció doboz az API Alapértelmezett URL címét mutatja egy másolás gombbal, a Dokumentáció megnyitása pedig az összes végpontot tartalmazó interaktív referenciához vezet.
Küldje el a kulcsot minden kéréssel, vagy Bearer tokenként az
Authorization fejlécben, vagy az X-Api-Key fejlécben. A kulcsok mak_ előtaggal kezdődnek.
Az a kérés, amelyhez a kulcsnak nincs meg a szükséges jogosultsága, elutasításra kerül.
Egy kulcs ahhoz a csapattaghoz kötődik, aki létrehozta. Ha ez a személy már nem tartozik a munkaterületéhez, a kulcs nem működik tovább, ezért a tartós kapcsolatokhoz olyan fiókkal hozzon létre kulcsot, amely megmarad.
A lista minden kulcsot a Név, Kulcs, Utoljára használva és Létrehozva adattal mutat. Az Utoljára használva legfeljebb percenként egyszer frissül, ami elég ahhoz, hogy lássa, használatban van-e még egy kulcs.
Kulcs módosítása, cseréje és törlése
Kattintson egy kulcsra a listában, vagy használja a sorában lévő ceruza ikont, a Szerkesztés gombot, a nevének vagy a jogosultságainak módosításához. A változások a Mentés gombbal lépnek életbe.
Ha egy kulcs kiszivároghatott, cserélje le. Ugyanebben az ablakban a Kulcs cseréje ezt kérdezi: „Lecseréli ezt a kulcsot? A régi titok azonnal leáll, és a külső integrációknak az újra lesz szükségük.” A megerősítés után az új kulcs egyszer megjelenik Az Ön új API-kulcsa ablakban. A név és a jogosultságok változatlanok maradnak, az Utoljára használva pedig elölről indul. Adja meg az új kulcsot minden eszközben, amely a régit használta.
Egy kulcs eltávolításához használja a sorában lévő kuka ikont, a Törlés gombot, vagy a Törlés gombot a megnyitott ablakban, és erősítse meg. Ettől kezdve minden eszköz kérését elutasítja a rendszer, amely még használja.
OAuth alkalmazások, egyszeri bejelentkezés és webhookok
A kulcs beillesztése nem az egyetlen módja a csatlakozásnak:
- Az OAuth alkalmazások révén más MemberAreák beillesztett API-kulcs helyett OAuth-tal köthetik össze az Ön szoftverét.
- Az Egyszeri bejelentkezés egy másik rendszerből jelentkezteti be a tagokat. Leírását a Bejelentkezés, regisztráció és SSO cikk tartalmazza.
- A tag- és fizetési eseményekhez tartozó webhookoknak saját oldaluk van a Beállítások > Webhookok alatt, amely akkor jelenik meg, ha a Fizetések be vannak kapcsolva.