Här kan du läsa hur du auktoriserar dina anrop mot våra Apier med OAuth2.
Vi använder OAuth2 för auktorisering av anrop mot våra Apier. Det innebär att alla anrop måste ha en Bearer Token (Access Token) i Authorization-headern, samt även en Subscriber Key. I denna sektion kan du läsa hur du ska anropa vår OpenIdConnect-server för att begära ut Access Tokens. Detta förutsätter att du först har registrerat dig i vår utvecklarportal, samt att du har registrerat din Klient hos oss.
Registrera ett utvecklarkonto
Registrera ett konto i vår utvecklarportalen och meddela din kontaktperson på Region Halland så kommer du att få behörighet till Api-dokumentationen. Du kan nu ansöka om en prenumeration på det Api du behöver tillgång till. Detta ger dig en Subscriber Key som ger dig grundläggande behörighet till Apierna. I samband med detta kommer vi kontakta dig för uppgifter som vi behöver för att registrera din applikation.
Registrera din applikation (Klient)
För att begära ut Access Tokens från vår OpenIdConnect-server måste du ha en Applikation/Klient registrerad. Vi använder termen Applikation och Klient som synonymer i denna aspekt.
- För att registrera en applikation behöver du:
- Ett namn på applikationen, oftast i form en minklient.mindoman.se
- Den publika delen av det certifikat som du kommer att signera dina biljettförfrågningar med (för att begära ett certifikat, följ de vanliga rutinerna)
- Redirect Uri till din applikation. Om du inte har någon Redirect Uri kan du ange urlen till webbplatsen.
När din applikation är registrerad får du ut ett client_id från Regionen som du ska använda när du hämtar ut biljetter, eller beställer behörigheter till Apier.
Om din applikation ska prata med flera Apier så ska du använda samma client id, men du måste hämta en biljett per resursid.
Vanligtvis behöver du registrera olika applikationer för test och produktion.
Beställ behörighet till Api
Din nyss registrerade applikation måste dessutom ha behörighet till Api. Detta måste beställas och registreras hos Regionen.
För att beställa behörighet till Apier behöver du:
- Client Id för din applikation.
- Resursid till det eller de apier som du vill ha access till (exempel: exempelapi.regionhalland.se)
- Scopes för respektive api som du behöver (exempel: exempelapi.Public)
- Registrera och Beställ behörighet till Api via ServiceDesk
Med denna mall i ServiceDesk kan du både Registrera och Beställa behörighet, om sitter utanför Region Hallands organisation får din kontaktperson utföra detta.
Välj rätt flöde för auktorisering
Beroende på vilket användningsfall du implementerar ska du använda olika OpenIdConnect eller OAuth2-flöden för att erhålla Access Tokens. Vissa Apier och eller vissa endpointar i ett Api kan kräva att slutanvändaren är identifierad. Vissa endpointar tillåter att endast applikationen (Klienten) är identifierad.
- Din applikation ska hämta opersonlig data från våra apier. Kräver inte att slutanvändaren är identifierad av Regionen. Använd OAuth2 Client Credentials Grant
- Din applikation ska hämta personlig data från våra apier. Kräver att slutanvändaren är identifierad av Regionen. Använd OAuth2 Authorization Code Grant