Forbind dine værktøjer med API'et
API'et giver en tredjepartsapplikation programmatisk adgang til din organisations data: medlemstal, kalendere, bookinger og fakturering. Det aktiveres med to klik og beskyttes med en nøgle, en liste over tilladte adresser og en overvågning af forbruget.
Find ud af, om API'et er noget for dig
API'et henvender sig til en udvikler, ikke til en organisationsansvarlig. Det bruges til at få din konto til at kommunikere med et program, som du får udviklet eller opsat: et skræddersyet website, et regnskabsprogram, en hjemmelavet infoskærm eller en forbindelse til et andet system.
Til de daglige behov — hente listen over medlemmer, opdatere abonnementer i massevis, sende tal til bestyrelsen — dækker modulerne til import, eksport og rapporter behovet, uden at der skal skrives en eneste linje kode.
API'et udbydes i betaversion: dets funktion kan stadig ændre sig.
Aktivér API'et og hent din nøgle
- Gå til Administration›Indstillinger›API BETA.
- Aktivér Aktivér API-modulet, og klik derefter på Gem.
- Din API-nøgle vises: kopiér den med knappen Kopier, og videregiv den udelukkende til det værktøj, du forbinder.
Nøglen sendes i HTTP-headeren X-API-Key ved hver forespørgsel. Kald skal altid ske via HTTPS; ingen ukrypteret forespørgsel accepteres.
Beskyt nøglen
Nogle gode vaner er værd at minde det værktøj eller den leverandør, der bruger den, om:
- læg aldrig nøglen i et kodelager; gem den i en konfigurationsfil uden for kodelageret eller i en hemmelighedsmanager;
- begræns de tilladte adresser, så snart værktøjet kalder fra en fast server;
- generér nøglen på ny ved den mindste tvivl — utilsigtet offentliggørelse, lækkede logfiler, afslutning af en leverandørs opgave.
Knappen Regenerer beder om bekræftelse og gør derefter den gamle nøgle ugyldig med det samme. Alle applikationer, der brugte den, holder op med at fungere, indtil de har fået den nye: giv dem besked, før du klikker.
Begræns adgangen efter IP-adresse
Aktivér Begrænsning efter IP-adresse: kun forespørgsler fra de adresser, du angiver, accepteres, med en grænse på 10 IPv4-adresser. Indtast hver adresse, og bekræft med Tilføj; din nuværende adresse vises på skærmen som hjælp.
Det er den mest effektive beskyttelse og den, der oftest overses: selv hvis nøglen slipper ud, er en nøgle, der er begrænset til din leverandørs adresse, ubrugelig andre steder.
Følg forbruget
Skærmen viser løbende, hvad din nøgle forbruger:
- Brug denne minut og Brug i dag, hver især sat i forhold til sin grænse, når en grænse er konfigureret;
- Brugsstatistikker: Denne uge, Denne måned, Total og Sidste forespørgsel.
Ud over de angivne grænser afvises yderligere forespørgsler midlertidigt. En tæller, der konstant ligger tæt på sit loft, er som regel tegn på et dårligt indstillet værktøj, der henter de samme data igen og igen i stedet for at cache dem.
Datoen for seneste forespørgsel er nyttig den anden vej: en nøgle, der er aktiveret, men ikke kaldt i månedsvis, er en nøgle, der bør deaktiveres.
Se, hvad API'et kan
Den fulde dokumentation med parametre og eksempler på kald vises nederst på modulets skærm. I hovedtræk:
- Brugere: det er den eneste ressource, der kan ændres. Du kan liste, se, oprette, ændre og slette konti.
- Konfiguration: abonnementer, profiler, grupper og aldersgrupper kan læses, men konfigureres kun fra applikationen.
- Booking: kalendere, ledige tidsrum, bookinger og etiketter kan læses.
- Fakturering: faktureringskonti, ordrer og betalinger kan læses.
