Savienojiet savus rīkus, izmantojot API
API ļauj trešās puses lietojumprogrammai programmatiski piekļūt jūsu organizācijas datiem: dalībnieku sarakstiem, kalendāriem, rezervācijām un norēķiniem. To aktivizē ar diviem klikšķiem, un to aizsargā atslēga, atļauto adrešu saraksts un patēriņa uzraudzība.
Noskaidrojiet, vai API ir domāta jums
API ir paredzēta izstrādātājam, nevis organizācijas vadītājam. Tā ļauj jūsu kontam sazināties ar programmatūru, kuru rakstāt vai konfigurējat pēc pasūtījuma: individuālu tīmekļa vietni, grāmatvedības rīku, paštaisītu informācijas ekrānu vai savienojumu ar citu sistēmu.
Ikdienas vajadzībām — iegūt biedru sarakstu, masveidā atjaunināt abonementus, nodot skaitļus valdei — importa, eksporta un atskaišu moduļi sniedz risinājumu, nerakstot nevienu koda rindiņu.
API tiek piedāvāta beta versijā: tās darbība vēl var mainīties.
Aktivizējiet API un iegūstiet savu atslēgu
- Dodieties uz Administrācija›Iestatījumi›API BETA.
- Aktivizējiet Aktivizēt API moduli un pēc tam noklikšķiniet uz Saglabāt.
- Tiek parādīta jūsu API atslēga: nokopējiet to ar pogu Kopēt un nododiet to tikai tam rīkam, kuru pievienojat.
Atslēgu nodod katra pieprasījuma HTTP galvenē X-API-Key. Izsaukumi obligāti jāveic, izmantojot HTTPS; nešifrēti pieprasījumi netiek pieņemti.
Aizsargājiet atslēgu
Dažus pamatprincipus ir vērts atgādināt rīkam vai pakalpojuma sniedzējam, kas to izmanto:
- nekad neievietojiet atslēgu koda repozitorijā; glabājiet to konfigurācijas failā ārpus repozitorija vai noslēpumu pārvaldniekā;
- ierobežojiet atļautās adreses, tiklīdz rīks veic izsaukumus no fiksēta servera;
- ģenerējiet atslēgu no jauna pie mazākajām šaubām — nejaušas publicēšanas, žurnālu noplūdes, pakalpojuma sniedzēja darba beigām.
Poga Ģenerēt no jauna prasa apstiprinājumu un pēc tam nekavējoties atceļ veco atslēgu. Visas lietojumprogrammas, kas to izmantoja, pārstāj darboties, līdz saņem jauno atslēgu: brīdiniet tās, pirms noklikšķināt.
Ierobežojiet piekļuvi pēc IP adreses
Aktivizējiet Ierobežojums pēc IP adreses: tiek pieņemti tikai pieprasījumi no adresēm, kuras norādāt sarakstā, ne vairāk kā 10 IPv4 adreses. Ievadiet katru adresi un apstipriniet ar Pievienot; jūsu pašreizējā adrese ir redzama ekrānā, lai jums palīdzētu.
Tā ir visefektīvākā un visbiežāk aizmirstā aizsardzība: pat nopludināta atslēga, kas ierobežota ar jūsu pakalpojuma sniedzēja adresi, citur paliek neizmantojama.
Sekojiet līdzi patēriņam
Ekrānā pastāvīgi tiek rādīts, ko patērē jūsu atslēga:
- Lietošana šajā minūtē un Lietošana šodien, katrs attiecināts pret savu ierobežojumu, ja ierobežojums ir konfigurēts;
- Lietošanas statistika: Šī nedēļa, Šis mēnesis, Kopā un Pēdējais pieprasījums.
Pārsniedzot norādītos ierobežojumus, papildu pieprasījumi uz laiku tiek noraidīti. Skaitītājs, kas pastāvīgi tuvojas savai robežai, parasti norāda uz slikti noregulētu rīku, kurš atkārtoti pieprasa tos pašus datus, nevis saglabā tos kešatmiņā.
Pēdējā pieprasījuma datums ir noderīgs pretējā virzienā: atslēga, kas ir aktivizēta, bet mēnešiem ilgi nav izmantota, ir jādeaktivizē.
Uzziniet, ko API ļauj darīt
Pilnā dokumentācija ar parametriem un izsaukumu piemēriem ir redzama moduļa ekrāna apakšdaļā. Vispārīgi:
- Lietotāji: šis ir vienīgais maināmais resurss. Jūs varat uzskaitīt, apskatīt, izveidot, mainīt un dzēst kontus.
- Konfigurācija: abonementus, profilus, grupas un vecuma kategorijas var apskatīt, bet konfigurēt tikai lietojumprogrammā.
- Rezervācijas: kalendārus, pieejamās laika nišas, rezervācijas un apzīmējumus var apskatīt.
- Norēķini: norēķinu kontus, pasūtījumus un maksājumus var apskatīt.
