Koble til verktøyene dine med API-et

API-et gjør det mulig for en tredjepartsapplikasjon å hente data fra organisasjonen din programmatisk: medlemmer, kalendere, reservasjoner og fakturering. Det aktiveres med to klikk og beskyttes av en nøkkel, en liste over tillatte adresser og en oversikt over forbruket.

Finn ut om API-et er relevant for deg

API-et er laget for en utvikler, ikke for en ansvarlig i organisasjonen. Det brukes til å få kontoen din til å kommunisere med en programvare du får utviklet eller satt opp: et skreddersydd nettsted, et regnskapsverktøy, en egenutviklet infoskjerm eller en kobling til et annet system.

For vanlige behov – hente listen over medlemmer, oppdatere abonnementer i bulk, sende tall til styret – dekker modulene for import, eksport og rapporter behovet uten at du trenger å skrive én linje kode.

API-et tilbys i betaversjon: virkemåten kan fortsatt endre seg.

Aktiver API-et og hent nøkkelen din

1. Gå til Administrasjon›Innstillinger›API BETA.
2. Aktiver Aktiver API-modulen og klikk deretter på Lagre.
3. API-nøkkel vises: kopier den med knappen Kopier og gi den kun til verktøyet du kobler til.

Nøkkelen sendes i HTTP-headeren X-API-Key i hver forespørsel. Alle kall må gjøres over HTTPS; ingen ukrypterte forespørsler godtas.

Beskytt nøkkelen

Noen gode vaner er verdt å minne verktøyet eller leverandøren som bruker den om:

• legg aldri nøkkelen i et kodelager; lagre den i en konfigurasjonsfil utenfor lageret eller i en hemmelighetsbehandler;
• begrens tillatte adresser så snart verktøyet kaller fra en fast server;
• generer nøkkelen på nytt ved minste tvil – utilsiktet publisering, lekkasje av logger, avsluttet oppdrag for en leverandør.

Knappen Regenerer ber om bekreftelse og ugyldiggjør deretter den gamle nøkkelen umiddelbart. Alle applikasjoner som brukte den, slutter å fungere til de har fått den nye: varsle dem før du klikker.

Begrens tilgangen etter IP-adresse

Aktiver Begrensning etter IP-adresse: bare forespørsler fra adressene du fører opp, godtas, med en grense på 10 IPv4-adresser. Skriv inn hver adresse og bekreft med Legg til; din nåværende adresse vises på skjermen som hjelp.

Dette er den mest effektive beskyttelsen, og den som oftest blir oversett: selv om en nøkkel lekker, er den ubrukelig andre steder når den er begrenset til leverandørens adresse.

Følg forbruket

Skjermen viser fortløpende hva nøkkelen din bruker:

• Bruk dette minuttet og Bruk i dag, hver sett opp mot grensen sin når en grense er satt;
• Bruksstatistikk: Denne uken, Denne måneden, Totalt og Siste forespørsel.

Ut over de angitte grensene avvises ytterligere forespørsler midlertidig. En teller som hele tiden ligger tett opp mot taket sitt, tyder vanligvis på et dårlig innstilt verktøy som ber om de samme dataene i sløyfe i stedet for å mellomlagre dem.

Datoen for siste forespørsel er nyttig i motsatt retning: en nøkkel som er aktivert, men ikke kalt i flere måneder, er en nøkkel du bør deaktivere.

Se hva API-et gjør mulig

Den fullstendige dokumentasjonen, med parametere og eksempler på kall, vises nederst på modulens skjerm. I korte trekk:

• Brukere: dette er den eneste ressursen som kan endres. Du kan liste, vise, opprette, endre og slette kontoer.
• Konfigurasjon: abonnementer, profiler, grupper og aldersklasser kan leses, men konfigureres kun fra applikasjonen.
• Reservasjon: kalendere, ledige tidsrom, reservasjoner og etiketter kan leses.
• Fakturering: fakturakontoer, ordrer og betalinger kan leses.