Įrankių prijungimas per API
API leidžia trečiosios šalies programai programiškai prieiti prie jūsų organizacijos duomenų: narių, kalendorių, rezervacijų ir sąskaitų išrašymo. Ji įjungiama dviem paspaudimais ir apsaugoma raktu, leidžiamų adresų sąrašu bei naudojimo stebėjimu.
Ar API skirta jums
API skirta programuotojui, o ne organizacijos vadovui. Ji naudojama tam, kad jūsų paskyra galėtų susikalbėti su programine įranga, kurią rašote ar konfigūruojate: individualiai sukurta interneto svetaine, buhalterine programa, savos gamybos informaciniu ekranu, tarpine sąsaja su kita sistema.
Kasdieniams poreikiams — narių sąrašui gauti, abonementams masiškai atnaujinti, skaičiams valdybai pateikti — pakanka importo, eksporto ir ataskaitų modulių, nerašant nė vienos kodo eilutės.
API teikiama beta versija: jos veikimas dar gali kisti.
API įjungimas ir rakto gavimas
- Eikite į Administravimas›Nustatymai›API BETA.
- Įjunkite Aktyvuoti API modulį ir spustelėkite Išsaugoti.
- Rodomas jūsų API raktas: nukopijuokite jį mygtuku Kopijuoti ir perduokite tik tam įrankiui, kurį prijungiate.
Raktas perduodamas kiekvienos užklausos HTTP antraštėje X-API-Key. Užklausos būtinai vykdomos per HTTPS; nešifruotos užklausos nepriimamos.
Rakto apsauga
Kelias taisykles verta priminti įrankiui ar paslaugų teikėjui, kuris jį naudoja:
- niekada nekelkite rakto į kodo saugyklą; laikykite jį konfigūracijos faile už saugyklos ribų arba slaptų duomenų valdymo priemonėje;
- apribokite leidžiamus adresus, kai tik įrankis siunčia užklausas iš fiksuoto serverio;
- sugeneruokite raktą iš naujo esant bet kokiam įtarimui — atsitiktinis paskelbimas, žurnalų nutekėjimas, paslaugų teikėjo darbo pabaiga.
Mygtukas Regeneruoti paprašo patvirtinimo ir tuoj pat paskelbia senąjį raktą negaliojančiu. Visos jį naudojusios programos nustos veikti, kol negaus naujojo: informuokite jas prieš spustelėdami.
Prieigos apribojimas pagal IP adresą
Įjunkite Apribojimas pagal IP adresą: priimamos tik iš jūsų nurodytų adresų atėjusios užklausos, ne daugiau kaip 10 IPv4 adresų. Įrašykite kiekvieną adresą ir patvirtinkite mygtuku Pridėti; jums padėti ekrane rodomas jūsų dabartinis adresas.
Tai veiksmingiausia ir dažniausiai užmirštama apsauga: net atskleistas raktas, apribotas jūsų paslaugų teikėjo adresu, kitur bus nenaudingas.
Naudojimo stebėjimas
Ekrane nuolat rodoma, kiek naudoja jūsų raktas:
- Naudojimas šią minutę ir Naudojimas šiandien, kiekvienas lyginamas su savo riba, kai riba yra nustatyta;
- Naudojimo statistika: Šią savaitę, Šis mėnuo, Iš viso ir Paskutinis užklausa.
Pasiekus nurodytas ribas, papildomos užklausos laikinai atmetamos. Skaitiklis, kuris nuolat artinasi prie savo viršutinės ribos, paprastai rodo netinkamai sukonfigūruotą įrankį, kuris be perstojo prašo tų pačių duomenų, užuot juos kaupęs podėlyje.
Paskutinės užklausos data naudinga kita linkme: įjungtas raktas, kuriuo mėnesius nesiųsta nė viena užklausa, yra raktas, kurį reikia išjungti.
Ką leidžia API
Visa dokumentacija su parametrais ir užklausų pavyzdžiais rodoma modulio ekrano apačioje. Trumpai:
- Naudotojai: tai vienintelis keičiamas išteklius. Galite peržiūrėti sąrašą, atverti, kurti, keisti ir naikinti paskyras.
- Konfigūracija: abonementus, profilius, grupes ir amžiaus kategorijas galima peržiūrėti, bet konfigūruoti tik programoje.
- Rezervacijos: galima peržiūrėti kalendorius, laisvus laiko intervalus, rezervacijas ir etiketes.
- Sąskaitų išrašymas: galima peržiūrėti sąskaitų išrašymo paskyras, užsakymus ir mokėjimus.