Eszközeinek összekapcsolása az API-val
Az API lehetővé teszi, hogy egy külső alkalmazás programozott módon érje el a szervezete adatait: taglétszám, naptárak, foglalások és számlázás. Két kattintással bekapcsolható, és egy kulcs, egy engedélyezett címlista, valamint a felhasználás nyomon követése védi.
Honnan tudja, hogy szükség van-e Önnek az API-ra
Az API fejlesztőknek szól, nem szervezeti vezetőknek. Arra szolgál, hogy a fiókja kommunikálni tudjon egy olyan szoftverrel, amelyet Ön megíratott vagy beállíttatott: egyedi weboldal, könyvelési eszköz, saját kijelző, átjáró egy másik rendszerhez.
A szokásos igényekhez – a tagok listájának letöltése, előfizetések csoportos frissítése, számok továbbítása a vezetőségnek – az import, az export és a jelentések modulja egyetlen kódsor megírása nélkül is megfelel.
Az API béta változatban érhető el: a működése még változhat.
Az API bekapcsolása és a kulcs beszerzése
- Nyissa meg a következőt: Adminisztráció›Beállítások›API BETA.
- Kapcsolja be a következőt: Aktiválja az API modult, majd kattintson a Mentés elemre.
- Megjelenik a API kulcs: másolja ki a Másolás gombbal, és kizárólag annak az eszköznek adja át, amelyet összekapcsol.
A kulcsot minden kérés X-API-Key HTTP-fejlécében kell elküldeni. A hívások kötelezően HTTPS-en történnek; titkosítás nélküli kérést a rendszer nem fogad el.
A kulcs védelme
Néhány alapszabályt érdemes felidézni annak az eszköznek vagy szolgáltatónak, amely használja:
- soha ne tegye a kulcsot kódtárolóba; tárolja a tárolón kívüli konfigurációs fájlban vagy titokkezelőben;
- szűkítse az engedélyezett címeket, amint az eszköz állandó szerverről hív;
- a legkisebb kétség esetén hozzon létre új kulcsot – véletlen közzététel, naplók kiszivárgása, egy szolgáltató munkájának lezárása.
A Újragenerálás gomb megerősítést kér, majd azonnal érvényteleníti a korábbi kulcsot. Minden alkalmazás, amely azt használta, működésképtelen lesz, amíg meg nem kapja az újat: kattintás előtt értesítse őket.
Hozzáférés korlátozása IP-cím szerint
Kapcsolja be a Korlátozás IP-cím alapján funkciót: ekkor csak az Ön által felsorolt címekről érkező kérések kerülnek elfogadásra, legfeljebb 10 IPv4-cím erejéig. Írja be az egyes címeket, majd hagyja jóvá a Hozzáadás gombbal; a jelenlegi címe megjelenik a képernyőn, segítségként.
Ez a leghatékonyabb védelem, és egyben az, amelyet a legtöbben elhanyagolnak: egy kiszivárgott kulcs is használhatatlan marad máshol, ha a szolgáltatója címére van korlátozva.
A felhasználás követése
A képernyő folyamatosan megjeleníti, mit fogyaszt a kulcsa:
- Használat ebben a percben és Mai használat, mindegyik a saját korlátjához mérten, ha van beállított korlát;
- Használati statisztikák: Ezen a héten, Ebben a hónapban, Összesen és Utolsó kérés.
A megadott korlátokon túl a további kéréseket a rendszer ideiglenesen visszautasítja. Egy folyamatosan a felső határ közelében járó számláló általában rosszul beállított eszközre utal, amely körbe-körbe ugyanazokat az adatokat kéri le, helyett hogy gyorsítótárba helyezné őket.
Az utolsó kérés dátuma a másik irányban is hasznos: az a kulcs, amely be van kapcsolva, de hónapok óta nem hívták meg, kikapcsolásra érett.
Mit tesz lehetővé az API
A teljes dokumentáció a paraméterekkel és hívási példákkal a modul képernyőjének alján olvasható. Nagy vonalakban:
- Felhasználók: ez az egyetlen módosítható erőforrás. Fiókokat listázhat, megtekinthet, létrehozhat, módosíthat és törölhet.
- Konfiguráció: az előfizetések, profilok, csoportok és korcsoportok megtekinthetők, de kizárólag az alkalmazásból állíthatók be.
- Foglalás: a naptárak, a szabad időpontok, a foglalások és a foglalási címkék megtekinthetők.
- Számlázás: a számlázási fiókok, a megrendelések és a fizetések megtekinthetők.
