Kom i gang med Dstny analytics og statistik API

API dokumentation

Dokumentationen kan findes her:

https://meridix.atlassian.net/wiki/spaces/MS36MEN/pages/5046278/HTTP+WebAPI

Derudover kan dokumentationen for hvert API endpoint findes her:

https://statistics.connect.ipvision.dk/api/doc

Sidstnævnte kræver et login, som Dstny DK leverer til dig.

 

API autorisering

For at anvende API'et, skal der oprettes en API token. Denne kan laves på bruger- eller organisationsniveau. Vi anbefaler at den laves på organisationsniveau, for at forhindre problemer hvis den tilknyttede bruger bliver slettet eller ændret på en måde som ændrer API'ets opførsel.

Note: Når en API token er oprettet på organisationsniveau, vil alle tidsstempler der bliver returneret fra API'et, være i UTC. Hvis API token'en er oprettet på en bruger, vil tidsstemplerne følge brugerens tidszone-indstillinger.

Når du har fået adgang til en API token, skal denne bruges til bearer-autorisering på alle API-kald. Logikken til at lave en signeret bearer-autorisering kan ses her:

https://meridix.atlassian.net/wiki/spaces/MS36MEN/pages/5046278/HTTP+WebAPI

(denne side indeholder også kode-eksempler for en række populære sprog)

Når signeringen er lavet skal token'en bruges i en Authorization header med værdien: "Bearer <token>".

 

Brug af API'et

Base-URL'en til API'et er: https://statistics.connect.ipvision.dk/

API'et har mange indstillinger til at justere hvad API'et returnerer og hvordan. For at komme i gang med at bruge API'et, anbefaler vi at du starter med at anvende web GUI'en (på https://statistics.connect.ipvision.dk) til at generere en rapport, som indeholder de data du vil hente via API'et. Når du har gjort det, kan du downloade en JSON-fil som indeholder det payload der skal sendes til API'et for at få de data som GUI'en har brugt til at generere den grafiske visning.

For at hente JSON-payloadet, skal du klikke på tabben "Information om rapporten":

 

Og derefter klikke på knappen "Download HTTP Request API JSON parameter for current report":

 

Den downloadede fil indeholder præcis det JSON payload der skal sendes til API'et for at få de samme data som web GUI'en har brugt til at generere rapporten.

 

Opkaldsspecifikationer

Når du henter data fra rapport-API'et, vil du altid få en række grupperede objekter, som bruges til at præsentere akkumulerede data på samme måde som hvad der vises i web GUI'en. Disse data indeholder ikke specifikationer for hvert opkald, men kun statistiske data baseret på dem, grupperet i tidsintervaller etc.

Men i nogle tilfælde kan der være brug for at få data om de specifikke opkald.

For at få dem med i svaret fra API'et, skal boolean'en "IncludeSpecificationLists" sættes til "true" i JSON payloadet (i rod-objektet). Herefter vil API'et inkludere et nyt rod-objekt, "specifications", som har et underobjekt, "calls", som er en liste over alle kaldene som rapporten er baseret på, samt informationer om dem.

Nummermaskering

Som udgangspunkt vil alle telefonnumre været maskeret i form af at de sidste 3 cifre er erstattet med stjerner. Dette er af datasikkerhedshensyn. Hvis der er brug for at se alle cifrene, kan Dstny DK slå denne maskering fra. Dette er på kundens eget ansvar og ændringen gælder både for at data returneret via API'et, samt data vist i web GUI'en.