...

Här beskrivs hur du går tillväga för att skapa ett API i WSO2 API Manager.

Konto

För att du ska kunna logga in i WSO2 API Manager krävs det att du har ett konto och är registrerad som “Publisher”. Skicka ett mail till Per Persson (per.z.persson@sundsvall.se) så skapar vi ett konto till dig.

Riktlinjer och regler

Innan du börjar publicera API:er så ska du ha koll på de riktlinjer och regler vi har kring livcykelhantering av API:er. Detta går att läsa på denna sida: Regler och riktlinjer

Under Livscykelhantering av APIer beskrivs vilka versioner av API:er som ska publiceras i vilken gateway och på vilken endpoint m.m.

Skapa ett API utifrån en OpenAPI-specifikation (swagger)

1. Surfa in på webbadressen till WSO2 API Manager Publisher, denna adress slutar på: /publisher/apis

   1. Test: https://api-im-test.sundsvall.se/publisher/apis

   2. Produktion: https://api-im.sundsvall.se/publisher/apis

2. Logga in med dina användaruppgifter.

3. Klicka på “CREATE API” och välj “I Have an Existing REST API”.

4. Välj att antingen bifoga en länk till din OpenAPI-specifikation eller välj att ladda upp den direkt från din dator.

5. I fältet “Name” anger du ett namn på ditt API. Detta namn kommer endast synas i API Managern. Välj därför ett namn som är tydligt för de som ska konsumera ditt API. Versal som första bokstav.

6. I fältet “Context” anger du starten på sökvägen till ditt API. Detta är oftast samma som namnet på API:t men här ska det endast förekomma gemener. Eventuella mellanrum skrivs med bindestreck (example-with-spaces).

7. I fältet “Version” anger du versionen på ditt API. Denna version inkluderas i sökvägen till ditt API.

8. I fältet “Endpoint” anger du sökvägen till ditt bakomliggande API.

9. I fältet “Business plan(s)” anger du om du vill ha någon begränsning på antal anrop till ditt API.

10. Nu har du skapat ett API. För att klienter ska kunna anropa ditt API så måste du publicera det. Men först ska vi gå igenom några delar som är bra att känna till innan vi gör det.

Exponera internt och/eller externt

Tänk på skillnaden mellan olika endpoints och vilken API Gateway de exponeras i. Detta beskrivs här: https://sundsvall.atlassian.net/wiki/spaces/SK/pages/344588314/Livscykelhantering+av+APIer#Hur-konfigurerar-vi-APIer-i-API-Manager%3F

1. När du är inne på ditt API i API Manager Publisher så finns fliken “Enivronments” till vänster. Klicka på den.

2. Här kan du välja hur API:t ska exponeras.

   1. Valet “Production and Sandbox” innebär att API:t exponeras i vår interna gateway och endast går att nå internt på Sundsvalls kommuns nät.

   2. Valet “External Production and Sandbox” innebär att API:t exponeras externt och går att nå utanför Sundsvalls kommuns nät

3. Klicka på “Save” för att spara ändringen.

...

1. När du är inne på ditt API i API Manager Publisher så finns fliken “Runtime Configurations” till vänster. Klicka på den.

2. Här kan du se “Application Level Security”. Klicka på texten så expanderas fältet.

3. Här kan du välja vilken typ av säkerhet som ska användas på ditt API.

   1. Standard-inställningen är “Oauth2” och denna säkerhet används för icke öppna API:er (informationssäkerhetsnivå > 0). Detta är en säkerhetstyp med en tidsbegränsad accessnyckel.

   2. Ett annat alternativ för öppna API:er (informationssäkerhetsnivå = 0) är att använda säkerhetstypen “Api Key”. Detta är en säkerhetstyp med en statisk accessnyckel.

4. Klicka i det alternativ som stämmer överens med ditt API och klicka på “Save” för att spara ändringar.

Transport level security

1. Under samma flik som i tidigare steg (“Runtime Configurations”) ska vi även konfigurera transportprotokoll.

2. Klicka på “Transport level security” och säkerställ att endast “HTTPS” är markerad.

3. Klicka sedan på “Save” för att spara ändringarna.

Publicera API

1. Nu har vi kommit fram till det sista steget. Att publicera ditt API för de som vill konsumera det.

2. När du är inne på ditt API i API Manager Publisher så finns fliken “Lifecycle” till vänster. Klicka på den.

3. För att kunna publicera ditt API så krävs det att du har uppfyllt vissa kriterier. Dessa ser du till höger:

   

4. När du har verifierat att alla kriterier är uppfyllda så klickar du på knappen “Publish”.

5. Nu är ditt API publicerat och redo att användas!

...

1. Surfa in på webbadressen till WSO2 API Manager Developer Portal, denna adress slutar på: /devportal

   1. Test: https://api-im-test.sundsvall.se/devportal/apis

   2. Produktion: https://api-im.sundsvall.se/devportal/apis

2. Gå in på fliken “Applications”. Här kan du se alla tillagda användare.

3. För att lägga till en ny användare klickar du på knappen “ADD NEW APPLICATION”

4. I fältet “Application Name” fyller du i namnet på den klient som ska läggas upp som användare. Tänk på att använda ett tydligt namn som alla kan förstå och undvik helst förkortningar.

5. I fältet “Per Token Quota” kan du välja om du vill sätta någon begränsning på antal anrop som denna användare kan göra.

6. I fältet “Application Description” kan du skriva en beskrivning om användaren.

7. Klicka på “Save”. Nu är din användare upplagd!

...

• “Production keys”, dessa nycklar används för att anropa API:ernas “Sandbox “Production endpoint”

• “Sandbox keys”, dessa nycklar används för att anropa API:ernas “Sandbox endpoint”

...