Koppla dina verktyg med API:et
API:et gör det möjligt för en tredjepartsapplikation att komma åt din organisations data på ett programmatiskt sätt: medlemmar, kalendrar, bokningar och fakturering. Det aktiveras med två klick och skyddas av en nyckel, en lista över tillåtna adresser och en uppföljning av användningen.
Ta reda på om API:et är till för dig
API:et riktar sig till en utvecklare, inte till en organisationsansvarig. Det används för att låta ditt konto kommunicera med en programvara som du låter utveckla eller konfigurera: en skräddarsydd webbplats, ett bokföringsverktyg, en egen informationsskärm, en koppling till ett annat system.
För vanliga behov — hämta medlemslistan, uppdatera abonnemang i grupp, skicka siffror till styrelsen — räcker modulerna för import, export och rapporter, utan att en enda rad kod behöver skrivas.
API:et erbjuds i betaversion: dess funktion kan fortfarande komma att ändras.
Aktivera API:et och hämta din nyckel
- Gå till Administration›Inställningar›API BETA.
- Aktivera Aktivera API-modulen och klicka sedan på Spara.
- Din API-nyckel visas: kopiera den med knappen Kopiera och lämna den enbart till det verktyg som du kopplar.
Nyckeln skickas i HTTP-huvudet X-API-Key i varje förfrågan. Anropen måste ske via HTTPS; ingen okrypterad förfrågan accepteras.
Skydda nyckeln
Några vanor är värda att påminna det verktyg eller den leverantör som använder nyckeln om:
- lägg aldrig nyckeln i ett kodarkiv; lagra den i en konfigurationsfil utanför arkivet eller i en hanterare för hemligheter;
- begränsa de tillåtna adresserna så snart verktyget anropar från en fast server;
- generera om nyckeln vid minsta tvivel — oavsiktlig publicering, läckta loggar, avslutat uppdrag för en leverantör.
Knappen Regenerera begär en bekräftelse och gör sedan den gamla nyckeln ogiltig omedelbart. Alla applikationer som använde den slutar fungera fram till dess att de har fått den nya: informera dem innan du klickar.
Begränsa åtkomsten per IP-adress
Aktivera Begränsning via IP-adress: endast förfrågningar från de adresser du listar accepteras, med en gräns på 10 IPv4-adresser. Ange varje adress och bekräfta med Lägg till; din nuvarande adress visas på skärmen som hjälp.
Det är det mest effektiva skyddet, och det som oftast förbises: även om nyckeln avslöjas förblir en nyckel som är begränsad till din leverantörs adress oanvändbar någon annanstans.
Följ användningen
Skärmen visar löpande vad din nyckel förbrukar:
- Användning denna minut och Användning idag, var och en satt i relation till sin gräns när en gräns är konfigurerad;
- Användningsstatistik: Denna vecka, Denna månad, Totalt och Sista förfrågan.
Utöver de angivna gränserna nekas ytterligare förfrågningar tillfälligt. En räknare som ständigt ligger nära sitt tak tyder oftast på ett felinställt verktyg som begär samma data om och om igen i stället för att cacha dem.
Datumet för den senaste förfrågan är användbart i motsatt riktning: en nyckel som är aktiverad men aldrig har anropats på månader är en nyckel att inaktivera.
Upptäck vad API:et gör möjligt
Den fullständiga dokumentationen, med parametrar och exempel på anrop, visas längst ned på modulens skärm. I stora drag:
- Användare: det är den enda resurs som kan ändras. Du kan lista, visa, skapa, ändra och ta bort konton.
- Konfiguration: abonnemang, profiler, grupper och ålderskategorier kan läsas, men konfigureras endast från applikationen.
- Bokning: kalendrar, lediga tidsluckor, bokningar och etiketter kan läsas.
- Fakturering: faktureringskonton, ordrar och betalningar kan läsas.