Povežite svoja orodja z API
API omogoča zunanji aplikaciji programski dostop do podatkov vaše organizacije: članstva, koledarjev, rezervacij in obračunavanja. Vklopite ga z dvema kliki, zaščitite pa ga s ključem, seznamom dovoljenih naslovov in spremljanjem porabe.
Ugotovite, ali je API namenjen vam
API je namenjen razvijalcu, ne vodji organizacije. Uporablja se za povezovanje vašega računa s programsko opremo, ki jo naročite ali nastavite: spletna stran po meri, računovodski program, lastni prikazovalni zaslon, povezava do drugega sistema.
Za običajne potrebe — pridobitev seznama članov, množično posodabljanje naročnin, posredovanje podatkov vodstvu — zadostujejo moduli za uvoz, izvoz in poročila, brez pisanja ene same vrstice kode.
API je na voljo v različici beta: njegovo delovanje se lahko še spremeni.
Vklopite API in pridobite svoj ključ
- Pojdite v Administracija›Nastavitve›API BETA.
- Vklopite Aktiviraj API modul, nato kliknite Shrani.
- Prikaže se vaš API ključ: kopirajte ga z gumbom Kopiraj in ga posredujte izključno orodju, ki ga povezujete.
Ključ se posreduje v glavi HTTP X-API-Key vsake zahteve. Klici morajo obvezno potekati po HTTPS; nešifrirane zahteve niso sprejete.
Zaščitite ključ
Nekaj navad je vredno spomniti orodju ali izvajalcu, ki ga uporablja:
- ključa nikoli ne shranjujte v repozitorij kode; shranite ga v konfiguracijsko datoteko zunaj repozitorija ali v upravljalnik skrivnosti;
- omejite dovoljene naslove takoj, ko orodje kliče s stalnega strežnika;
- ob najmanjšem dvomu ključ obnovite — nenamerna objava, uhajanje dnevnikov, konec sodelovanja z izvajalcem.
Gumb Regeneriraj zahteva potrditev, nato takoj razveljavi stari ključ. Vse aplikacije, ki so ga uporabljale, prenehajo delovati, dokler ne prejmejo novega: obvestite jih, preden kliknete.
Omejite dostop po naslovu IP
Vklopite Omejitev po IP naslovu: sprejete so le zahteve z naslovov, ki jih navedete, do največ 10 naslovov IPv4. Vnesite vsak naslov in potrdite z Dodaj; vaš trenutni naslov je prikazan na zaslonu v pomoč.
To je najučinkovitejša in najpogosteje zanemarjena zaščita: tudi razkrit ključ, omejen na naslov vašega izvajalca, ostane drugod neuporaben.
Spremljajte porabo
Zaslon neprekinjeno prikazuje, koliko porabi vaš ključ:
- Uporaba ta trenutek in Uporaba danes, vsaka glede na svojo omejitev, kadar je omejitev nastavljena;
- Statistika uporabe: Ta teden, Ta mesec, Skupaj in Zadnja zahteva.
Nad navedenimi omejitvami so dodatne zahteve začasno zavrnjene. Števec, ki se nenehno približuje svoji zgornji meji, običajno kaže na slabo nastavljeno orodje, ki iste podatke zahteva v zanki, namesto da bi jih shranjevalo v predpomnilnik.
Datum zadnje zahteve je uporaben v nasprotni smeri: ključ, ki je vklopljen, a ga mesece nihče ne kliče, je ključ, ki ga je treba izklopiti.
Odkrijte, kaj API omogoča
Celotna dokumentacija s parametri in primeri klicev je prikazana na dnu zaslona modula. Na grobo:
- Uporabniki: to je edini vir, ki ga je mogoče spreminjati. Račune lahko izpišete, pregledate, ustvarite, spremenite in izbrišete.
- Konfiguracija: naročnine, profili, skupine in starostne kategorije so na voljo za vpogled, nastavljajo pa se izključno v aplikaciji.
- Rezervacije: koledarji, prosti termini, rezervacije in oznake so na voljo za vpogled.
- Obračunavanje: obračunski računi, naročila in plačila so na voljo za vpogled.
