Denne side beskriver adgangen til og den tekniske distribution af GraphQL, som er gældende for alle registre på Datafordeleren, der udstiller data med GraphQL.
Siden beskriver hvordan anvendere på Datafordeleren kan benytte GraphQL-tjenesterne til at hente tabulære data fra registrene.
Point POINT (3 5) Line LINESTRING (6 4, 8 2, 7 1) Polygon POLYGON (1 1, 3 3, 4 2, 4 0, 1 1) |
1) Åben Postman og klik på ”Collections” i venstre side. Collections er en folder/mappe med et bestemt navn, hvor du kan samle alle dine queries til Datafordeleren og eventuelt navngive dem efter behov.
For at oprette en collection trykker du på ”+” ikonet og vælger ”Blank collection”. Derefter kan du i toppen navngive din collection.
2) Når en collection er oprettet, kan du oprette en request ved at højreklikke på sin collection eller trykke på de 3 prikker og derefter vælge ”Add request”.
Her kan du også navngive din request efter behov.
3) Når requesten er oprettet kan du i HTTP metoden vælge GET, hvis du vil hente et GraphQL-skema, eller POST hvis du vil sende en query.
Dette eksempel tager udgangspunkt i en POST request med OAuth-credentials til BBR.
I feltet til URL’en kan du indsætte https://graphql.datafordeler.dk/BBR/v1 for at kunne lave queries til BBR-version 1.
4) Vælg requesten i venstre side (hvis den ikke allerede er aktiv som i det forrige trin) og klik på ”Authorization” for at skifte til en anden fane. Her skal du vælge ”OAuth 2.0” i ”Auth Type” menuen.
Postman skulle gerne skifte indholdet når du har valgt en ny auth type.
5) Du skal herefter scrolle ned i den aktive ”Authorization” fane indtil du kan se en ”Configure New Token” overskriften.
Under overskriften vil der være en række felter som skal udfyldes som beskrevet herunder.
- I ”Token Name” kan du give din Access Token et passende navn.
- I ”Grant type” menuen skal du vælge ”Client Credentials”. Her vil Postman ændre felterne under med dem som relevant for din konfiguration af OAuth.
- I ”Access Token URL” skal du indsætte følgende link - https://auth.datafordeler.dk/realms/distribution/protocol/openid-connect/token
- I ”Client ID” skal du indsætte det Client ID som de har modtaget efter at have oprettet det i OAuth sektionen på Datafordeler Administration.
- I ”Client Secret” skal du indsætte den Shared Secret som du har modtaget efter at have oprettet det i OAuth sektionen på Datafordeler Administration.
- Anvenderen kan ignorere ”Scope” feltet, men skal verificere at ”Client Authentication” feltet er sat til ”Send as Basic Auth header”.
6) Efter du har udfyldt de nødvendige felter, kan du hente dit Access Token ved at rulle ned indtil du ser en orange knap der hedder ”Get New Access Token” og klikke på den.
Derefter vil Postman åbne et vindue som indikerer at applikationen er gået i gang med at hente Access Token fra Datafordeleren.
Når Access Token er hentet, vil Postman opdatere vinduet med et grønt flueben og med teksten ”Authentication complete”. Herefter kan du vente 5 sekunder eller trykke på ”Proceed” knappen i nederste højre hjørne. Herefter vil Postman åbne et nyt vindue.
7) Når Postman har åbnet det næste vindue, vil Access token og dets navn stå under ”Token Details”.
Du kan nu trykke på ”Use Token” til at bruge den til at lave queries i Postman eller kopierer access token til anden applikation.
8) Hvis du trykker på ”Use Token” vil Postman automatisk udfylde det i den request som du oprettede tidligere. Herefter kan du lukke vinduet og klikke på ”Body” fanen, efterfuldt ved at klikke på GraphQL muligheden længst til højre. Til sidst kan du skrive en GraphQL-query til BBR og indsætte det i ”Query” tekstfeltet.
9) Når du er klar til at indsende din query kan du trykke på ”Send” oppe i højre hjørne.
Herefter vil svaret fra GraphQL tjenesten blive vist i bunden.
2) Herefter skal OAuth 2.0-indstillinger opsættes for certifikatet. Gå ind under ”Authorization” i requesten, og scroll ned til ”Configure New Token”.
Under overskriften vil der være en række felter som skal udfyldes som beskrevet herunder.
a. I ”Token Name” kan du give din Access Token et passende navn.
b. I ”Grant type” menuen skal du vælge ”Client Credentials”. Her vil Postman ændre felterne under med dem som relevant for din konfiguration af OAuth.
c. I ”Access Token URL” skal du indsætte følgende link - https://auth-oces.datafordeler.dk/realms/distribution/protocol/openid-connect/token.
d. I ”Client ID” skal anvenderen indsætte det Client ID som de har modtaget efter at have oprettet det i OAuth sektionen på Datafordeler Administration.
e. Du kan ignorere ”Scope” feltet, men skal verificere at ”Client Authentication” feltet er sat til ”Send client credentials in body”.
3) Vælge ”Settings” oppe i højre hjørne:
4) Vælg herefter ”Add Certificate”.
5) Angiv herefter ”host” og certifikatet.
- Host skal være https://auth-oces.datafordeler.dk.
- PFX file skal pege på certifikatet som indeholder den private nøgle. Det er vigtigt at dette certifikat stemmer overens med det certifikat som blev uploadet inde i portalen.
- Passphrase skal stemme overens med password til certifikatet.
- Bemærk at det kan være nødvendigt at installere ”Den Danske Stat” rodcertifikatet på anvenders maskine for at maskinen stoler på det certifikat der er vedhæftet inde i Postman.
