Prepojenie vašich nástrojov pomocou API
API umožňuje aplikácii tretej strany programovo pristupovať k údajom vašej organizácie: k členom, kalendárom, rezerváciám a fakturácii. Aktivuje sa dvoma kliknutiami a chráni sa kľúčom, zoznamom povolených adries a sledovaním spotreby.
Zistite, či je API určené pre vás
API je určené pre vývojára, nie pre vedúceho organizácie. Slúži na to, aby váš účet komunikoval so softvérom, ktorý si necháte napísať alebo nastaviť: webová stránka na mieru, účtovný nástroj, vlastná informačná obrazovka, prepojenie na iný systém.
Na bežné potreby — získať zoznam členov, hromadne aktualizovať predplatenia, poslať čísla výboru — postačia moduly importu, exportu a prehľadov, a to bez napísania jediného riadku kódu.
API je k dispozícii vo verzii beta: jeho fungovanie sa ešte môže zmeniť.
Aktivujte API a získajte svoj kľúč
- Prejdite do Administrácia›Nastavenia›API BETA.
- Aktivujte Aktivovať modul API a potom kliknite na Uložiť.
- Zobrazí sa váš API kľúč: skopírujte ho tlačidlom Kopírovať a poskytnite ho iba nástroju, ktorý pripájate.
Kľúč sa posiela v HTTP hlavičke X-API-Key každej požiadavky. Volania sa musia povinne vykonávať cez HTTPS; žiadna nezašifrovaná požiadavka nie je akceptovaná.
Chráňte kľúč
Niekoľko zásad je vhodné pripomenúť nástroju alebo dodávateľovi, ktorý ho používa:
- nikdy neukladajte kľúč do repozitára kódu; uchovávajte ho v konfiguračnom súbore mimo repozitára alebo v správcovi tajných údajov;
- obmedzte povolené adresy vždy, keď nástroj volá zo stabilného servera;
- vygenerujte kľúč nanovo pri najmenšom podozrení — náhodné zverejnenie, únik zo záznamov, ukončenie spolupráce s dodávateľom.
Tlačidlo Regenerovať vyžiada potvrdenie a potom okamžite zneplatní starý kľúč. Všetky aplikácie, ktoré ho používali, prestanú fungovať, kým nedostanú nový: upozornite ich pred kliknutím.
Obmedzte prístup podľa IP adresy
Aktivujte Obmedzenie podľa IP adresy: akceptované budú len požiadavky prichádzajúce z adries, ktoré uvediete, a to najviac 10 adries IPv4. Zadajte každú adresu a potvrďte ju tlačidlom Pridať; vaša aktuálna adresa je zobrazená na obrazovke, aby vám pomohla.
Je to najúčinnejšia ochrana a zároveň najčastejšie zanedbávaná: aj keď kľúč unikne, kľúč obmedzený na adresu vášho dodávateľa zostane inde nepoužiteľný.
Sledujte spotrebu
Obrazovka priebežne zobrazuje, čo váš kľúč spotrebúva:
- Použitie tejto minúty a Použitie dnes, každá vztiahnutá k svojmu limitu, ak je limit nastavený;
- Štatistiky používania: Tento týždeň, Tento mesiac, Celkom a Posledná požiadavka.
Po prekročení uvedených limitov sú ďalšie požiadavky dočasne odmietnuté. Počítadlo, ktoré sa neustále približuje k svojmu stropu, zvyčajne signalizuje zle nastavený nástroj, ktorý si dookola vyžiada tie isté údaje namiesto toho, aby ich uložil do vyrovnávacej pamäte.
Dátum poslednej požiadavky je užitočný v opačnom smere: kľúč, ktorý je aktivovaný, ale mesiace nebol použitý, je kľúč, ktorý treba deaktivovať.
Zistite, čo API umožňuje
Úplná dokumentácia s parametrami a príkladmi volaní je zobrazená v spodnej časti obrazovky modulu. Vo veľkých rysoch:
- Používatelia: ide o jediný upravovateľný zdroj. Účty môžete vypisovať, zobrazovať, vytvárať, upravovať a mazať.
- Konfigurácia: predplatenia, profily, skupiny a vekové kategórie je možné zobraziť, no nastaviť sa dajú iba v aplikácii.
- Rezervácia: kalendáre, dostupné časové bloky, rezervácie a označenia je možné zobraziť.
- Fakturácia: fakturačné účty, objednávky a platby je možné zobraziť.
