Ühendage oma tööriistad API kaudu
API võimaldab kolmanda osapoole rakendusel pääseda programmiliselt ligi teie organisatsiooni andmetele: liikmeskond, kalendrid, broneeringud ja arveldus. Selle aktiveerite kahe klõpsuga ning kaitsete võtme, lubatud aadresside loendi ja kasutuse jälgimisega.
Kuidas teada, kas API on teie jaoks
API on mõeldud arendajale, mitte organisatsiooni juhile. See võimaldab teie kontol suhelda tarkvaraga, mida te lasete kirjutada või seadistada: eritellimusel valminud veebisait, raamatupidamistarkvara, ise ehitatud infoekraan või liides mõne teise süsteemiga.
Igapäevaste vajaduste jaoks — liikmete loendi väljavõtmine, abonementide massiline uuendamine, arvude edastamine juhatusele — piisab impordi-, ekspordi- ja aruandemoodulitest, ilma ühtki koodirida kirjutamata.
API on saadaval beetaversioonina: selle toimimine võib veel muutuda.
API aktiveerimine ja võtme hankimine
- Avage Haldus›Seaded›API BETA.
- Lülitage sisse Aktiveeri API-moodul ja klõpsake seejärel Salvesta.
- Kuvatakse teie API võti: kopeerige see nupuga Kopeeri ja edastage üksnes tööriistale, mida ühendate.
Võti edastatakse iga päringu HTTP-päises X-API-Key. Päringud tuleb teha alati HTTPS-i kaudu; krüpteerimata päringuid vastu ei võeta.
Võtme kaitsmine
Mõned harjumused tasub tööriistale või seda kasutavale teenusepakkujale meelde tuletada:
- ärge kunagi pange võtit koodihoidlasse; hoidke seda hoidlast väljaspool asuvas seadistusfailis või saladuste haldurisse;
- piirake lubatud aadresse kohe, kui tööriist teeb päringuid püsivalt samast serverist;
- looge võti uuesti vähimagi kahtluse korral — kogemata avaldamine, logide leke, teenusepakkuja töö lõppemine.
Nupp Regenereeri küsib kinnitust ja muudab seejärel vana võtme kohe kehtetuks. Kõik rakendused, mis seda kasutasid, lõpetavad töö kuni uue võtme saamiseni: teavitage neid enne klõpsamist.
Ligipääsu piiramine IP-aadressi järgi
Lülitage sisse Piirang IP-aadressi järgi: vastu võetakse ainult päringuid teie loetletud aadressidelt, kuni 10 IPv4-aadressi. Sisestage iga aadress ja kinnitage nupuga Lisa; abiks kuvatakse ekraanil teie praegune aadress.
See on kõige tõhusam ja kõige sagedamini tähelepanuta jäetud kaitse: ka lekkinud võti, mis on piiratud teie teenusepakkuja aadressiga, jääb mujal kasutuskõlbmatuks.
Kasutuse jälgimine
Ekraan näitab pidevalt, kui palju teie võti tarbib:
- Kasutamine sel minutil ja Kasutamine täna, kumbki võrreldud oma piiranguga, kui piirang on seadistatud;
- Kasutusstatistika: See nädal, See kuu, Kokku ja Viimane päring.
Näidatud piirangute ületamisel lükatakse lisapäringud ajutiselt tagasi. Loendur, mis on pidevalt oma ülempiiri lähedal, viitab tavaliselt halvasti seadistatud tööriistale, mis küsib samu andmeid ikka ja jälle, selle asemel et neid vahemällu salvestada.
Viimase päringu kuupäev on kasulik vastupidises olukorras: võti, mis on aktiveeritud, kuid mida pole kuude jooksul kasutatud, tuleks välja lülitada.
Mida API võimaldab
Täielik dokumentatsioon koos parameetrite ja päringunäidetega kuvatakse mooduli ekraani allosas. Peajoontes:
- Kasutajad: see on ainus muudetav ressurss. Saate kontosid loetleda, vaadata, luua, muuta ja kustutada.
- Seadistus: abonemente, profiile, gruppe ja vanuseklasse saab vaadata, kuid seadistada üksnes rakenduses.
- Broneerimine: kalendreid, vabu ajavahemikke, broneeringuid ja silte saab vaadata.
- Arveldus: arvelduskontosid, tellimusi ja makseid saab vaadata.
