Når en webservice konfigureres genereres der automatisk en url.
Opbygningen af url’en sker ud fra følgende kriterier, som angives i forbindelse med konfigurationen af webservicen:
Strukturen for den genererede url sker i overensstemmelse med følgende skema:
<scheme>://<authority>/<path>/?<parameters>
Strukturen for den samlede url sker i overensstemmelse med følgende skema, når<authority> og <path> bliver foldet ud:
<scheme>://<alias>.datafordeler.dk/<owner>/<service>/<version>/<metode>/?<parameters>
<scheme> Afgøres af den valgte protokol og vil altid være enten http eller https. Det anbefales ikke at sende brugernavn/adgangskode ukrypteret. Derfor bør der altid anvendes https, hvis disse sikkerhedsakkreditiver anvendes. <authority> udgøres af følgende mønster <alias>.datafordeler.dk
<path>udgøres af følgende mønster <owner>/<service>/<version>/<metode>
<parameters> |
Parametre dækker over både sikkerhedsparametre, standardparametre og tjenestespecifikke parametre.
Kald med certifikater skal ikke ske til det ”normale” endpoint, men skal gå til et separat endpoint specifikt for anvendelse af certifikater.
Url vil for webservices med certifikater i i zone 0 starter med.
https://certservices.datafordeler.dk/
Url vil for webservices med certifikater i i zone 5 starter med.
https://s5-certservices.datafordeler.dk/
Se endpoint for testmiljøerne i Listen over endpoint
Vil du benytte brugernavn/adgangskode som akkreditiver, skal parametre inkluderes i kald til tjeneste og den samlede url vil følge dette skema:
<scheme>://<alias>.datafordeler.dk/<owner>/<service>/<version>/<metode>/?username=xxx&password=yyy
Brugernavn og adgangskode er obligatoriske parametre, hvis tjenestebrugeren er oprettet på den måde. xxx - skal erstattes med brugernavn for tjenestebruger |
Det er muligt at anvende paging for de REST-services, der er konfigureret til det.
I webservicekatalogerne vil det fremgå af de generelle informationer om registrets webservices er konfigureret til at benytte paging samt informationer om en default paging-størrelse.
Benytter du paging vil den samlede url følge dette skema:
<scheme>://<alias>.datafordeler.dk/<owner>/<service>/<version>/<metode>/?page=xxx&pagesize=yyy
Følgende skal tilføjes url'en for at hente hændelsesbeskeder med paging: xxx - skal erstattes med nummeret på den side, som du ønsker. |
Antal elementer i resultatsættet returneres ved at angive parameteren count i REST kald.
Benytter du count vil den samlede url følge dette skema:
<scheme>://<alias>.datafordeler.dk/<owner>/<service>/<version>/<metode>/?count=true
Følgende skal tilføjes url'en for at hente antallet af elementer i resultatsættet: count=true |
REST-servicen kan returnere data i formaterne JSON og XML.
Vælger du at specificere formatet, vil den samlede url følge dette skema:
<scheme>://<alias>.datafordeler.dk/<owner>/<service>/<version>/<metode>/?format=xxx
En anden mulighed er at sætte accept headeren til "application/json" eller "application/xml".
Følgende skal tilføjes url'en for at hente hændelsesbeskeder med et bestemt format: xxx - skal erstattes med enten json eller xml. |
jsonpCallback: jsonp kan anvendes ved at angive jsonpCallback=xxx.
Nogle tjenester accepterer at en parameter består af en liste af værdier.
For de REST baserede webservices er dette understøttet ved at de enkelte værdier i listen adskilles af et ”|”-tegn (pipe karakter).
Eksempel med 4 værdier i en liste til en parameter: Værdi1|Værdi2|Værdi3|Værdi4
https://s5-certservices.datafordeler.dk/CPR/CprPerson/1/REST/PersonKompletListeHent?Format=JSON&pnr.personnummer.wi=xxxxxxxxxx|xxxxxxxxxx| |
Webservices kan i Datafordeleren konfigureres til at kræve kvitteringer fra anvenderen.
Alle forespørgsler til en webservice vil returnere en response-header med kvitteringsID ( receipt id) og kaldet DataDistributor.ReceiptId.
For at kvittere for data skal du sende en POST anmodning til kvitteringsservicen.
https://<endpoint>.datafordeler.dk/system/receipt/1/rest?username=xxx&password=yyy
med en request body der ser ud som (json eksempel):
{ "ReceiptId":"zzz" }
hvor “zzz” angiver kvitteringsID.
Du kan hente en ticket ved at kalde denne service:
https://<endpoint>/system/getticket/1/custom?service=xxx&username=yyy&password=zzz
Tilføj owner, service, version og metode samt tjenestebrugerens brugernavn og adgangskode til url'en.
Kald url'en i din browser og du får returneret din ticket til den service, som du ønsker at kalde.
Følgende skal tilføjes url'en for at hente en ticket xxx - skal erstattes med <path> (<owner>/<service>/<version>/<metode>) i url'en. |
Ticket skal erstatte brugernavn og adgangskode i url'en, når du kalder din tjeneste på følgende måde:
https://<endpoint>/<owner>/<service>/<version>/<metode>/<parameters>&ticket=ttt
Følgende skal tilføjes url'en for at hente en tjeneste med ticket ttt - skal erstattes med med den ticket, som du har hentet ved at kalde Ticket Serveren. |
For at hente en ticket for skærmkort benyttes følgende url: Her bliver xxx erstattet med <path> (Dkskaermkort/topo_skaermkort_wmts/1.0.0/wmts) i url'en, yyy bliver erstattet med tjenestebrugerens brugernavn i url'en og zzz bliver erstattet med tjenestebrugeren adgangskode i url'en. Eksempel på Ticket: 602a9a0954f44da0bbd40b6fc2f2f7fc Eksempel på url til Skærmkort med ticket: |