API
API-et er en dør for andre programmer. Det er ikke en side du bruker når du kjører kurs. Vanlige brukere trenger det ikke.
Når du trenger det
Du trenger API-et hvis et eget nettsted, et medlemssystem eller en rapport skal hente kurs, påmeldinger eller noe annet direkte fra Kursagenten, uten at noen klikker i kursadmin.
Hvor du finner det
Den tekniske oversikten (Swagger) over det som kan hentes og sendes, ligger på en egen adresse. Lenken Api under Innstillinger vises bare for Kursagentens egne administratorer, så bruk adressen under.
Adressen er developer.kursagenten.no/api/swagger.
Slik kommer dere i gang
- Bestem hva det andre systemet skal gjøre. For eksempel hente kurslisten, eller sende inn en påmelding.
- Be den som utvikler løsningen åpne Swagger-siden.
- Lag en egen API-tilgang til løsningen, som beskrevet under. Del ikke eier-passordet.
Hva API-et kan gjøre
- Kurs. Hente, opprette og endre kurs. Ved endring blir bare feltene som sendes inn, endret, så skjema og priser blir ikke nullstilt. Kurskode, språk og kurstider kan også sendes.
- Kursdatoer. Opprette, endre og slette datoer, også datoer tilbake i tid (helt tilbake til år 2000), og føre oppmøte per kursdag.
- Deltakere og påmeldinger. Melde på, flytte deltakere mellom kurs og bruke egne deltakerfelt. Mangler påmeldingen en egen betaler, blir første deltaker betaler. Påmelding til en avlyst kursdato blir avvist.
- Ordre, produkter og organisasjoner. Lese ordre. Lese og skrive produkter, organisasjoner og kontaktpersoner.
- Webhooks. Sette opp varsler til andre systemer, blant annet når en deltaker endres.
Hva som finnes, og hvordan det brukes, står på engelsk i Swagger-dokumentasjonen.
API-tilganger
Gå til Innstillinger → Integrasjonsinnstillinger og fanen API-tilganger. Øverst står API-adressen, dokumentasjonen og token-adressen. Klikk Ny API-tilgang for å lage en tilgang. Løsningen bruker client-id og secret til å hente et token. Secreten vises bare når den lages. Har dere mistet den, klikker du Lag ny secret.
- Tilgang er det tilgangen kan lese og skrive. Klikk blyanten for å endre. Du velger Les og Skriv for Kurs, Deltakere og påmeldinger, Ordre, Produkter og Organisasjoner. I tillegg kan du gi lov til å se fødselsnummer og til å administrere webhooks. Knappene Full tilgang, Bare kurskatalog og Lese alt fyller ut vanlige valg. Gi ikke mer tilgang enn løsningen trenger.
- Sist hentet token viser når tilgangen sist ble brukt.
- Opprettet viser når tilgangen ble laget. Hold musen over datoen for å se hvem som laget den.
- Deaktiver stenger tilgangen.
Endringer i tilgangen gjelder fra neste token. Kallene som gjøres med tilgangen, blir logget, så det er lettere å finne feil.


Merk: Kurs på egen nettside løses nesten alltid med iframe eller WordPress-utvidelsen, ikke med API. Se Vise kurs på egen webside.

