For at benytte Timeview's API, skal der i Timeview oprettes en bruger til dette formål. De rettigheder der tildeles brugeren, vil også være de rettigheder der vil kunne opnås igennem API kaldene.

Når brugeren er oprettet kontaktes supporten hos TimeSolution, hvor det oplyses hvilke brugere der skal have adgang via API'et, hvorefter TimeSolution vender retur med de relevante API nøgler.

Timeview's API bygger på OData protokollen. Du kan via swagger se alle tilgængelige endpoint. Swagger beskrivelsen finder du her.

Den API nøgle du har modtaget, skal tilføjes som en value til Key'en x-api-key og tilføjes i headeren.

Timeview anvender OData's server-driven paging til, at minimere mængden af data der returneres ved hvert kald. Når der hentes større mængder data, vil vores API have et maksimum antal af objekter, der kan hentes pr. kald. Denne værdi kan godt ændres, hvorfor det altid er en god ide at anvende attributten nextLink, som giver den præcise url der skal kaldes, indtil alle rækker er hentet frem. På den måde sikres det, at vi kan optimere kaldene, samt I ikke skal ind og ændre i jeres kode, hvis denne værdi ændres.

Såfremt der er brug for en bedre forklaring af fx enums værdier, vil de kunne søges frem via vores metadataside, som du finder her.

Hvis en API bruger forårsager kritiske udfordringer på Timeviews servere, kan det være nødvendigt at lukke for denne brugers adgang midlertidigt. Dette gøres for at opretholde en stabil drift for alle Timeview brugere.