| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
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.
...
Surfa in på webbadressen till WSO2 API Manager Publisher, denna adress slutar på: /publisher/apis
Logga in med dina användaruppgifter.
Klicka på “CREATE API” och välj “I Have an Existing REST API”.
Välj att antingen bifoga en länk till din OpenAPI-specifikation eller välj att ladda upp den direkt från din dator.
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.
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). Tänk på att inte ange samma rot-context i API:et i tjänsten, detta för att undvika url:er som https://api-test.sundsvall.se/nameofapi/1.0/nameofapi/dostuff. (Dvs dubblett av “nameofapi”)
I fältet “Version” anger du versionen på ditt API. Denna version inkluderas i sökvägen till ditt API.
I fältet “Endpoint” anger du sökvägen till ditt bakomliggande API.
I fältet “Business plan(s)” anger du om du vill ha någon begränsning på antal anrop till ditt API.
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.
...
Nu har vi kommit fram till det sista steget. Att publicera ditt API för de som vill konsumera det.
När du är inne på ditt API i API Manager Publisher så finns fliken “Lifecycle” till vänster. Klicka på den.
För att kunna publicera ditt API så krävs det att du har uppfyllt vissa kriterier. Dessa ser du till höger:
När du har verifierat att alla kriterier är uppfyllda så klickar du på knappen “Publish”.
Nu är ditt API publicerat och redo att användas!
Skapa användare
...
För att konsumenterna ska få tillgång till ditt API krävs det att de är upplagda som användare i WSO2 och prenumeranter på ditt API.
...
.
Användare för en ny klient (en ny kanal t ex) skapas i Carbon av t ex Per Persson (per.z.persson@sundsvall.se).
Skapa prenumeration på API
Surfa in på webbadressen till WSO2 API Manager Developer Portal, denna adress slutar på: /devportal
Gå Logga in på fliken “Applications”. Här kan du se alla tillagda användare.
För att lägga till en ny användare klickar du på knappen “ADD NEW APPLICATION”
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.
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.
I fältet “Application Description” kan du skriva en beskrivning om användaren.
Klicka på “Save”. Nu är din användare upplagd!
Prenumerera på API
När du är inne på WSO2 API Manager Developer Portal och fliken “Applications” så kan du se alla tillagda användare.
Klicka på den användare du vill lägga till som prenumerant.
Gå in på fliken “Subscriptions” till vänster
Klicka på “SUBSCRIBE APIS” och leta reda på det API du vill prenumerera på
Under “Policy” väljer du den “Business Plan” du vill att denna prenumerant ska gå under. Klicka sedan på “SUBSCRIBE”.
Nu prenumererar denna användare på ett API och kan därmed anropa det med de nycklar vi ska ta fram i nästa steg.
...
Developer Portal med den användare (t.ex. WSO2_OpenE) som skall prenumerera på APIet
Klicka på det API användaren skall prenumerera på
Klicka på “Subscriptions” i menyn till vänster
Klicka på “Subscribe” (se nedan - ändra inte under Application eller Throttling Policy)
Skapa nycklar för en prenumerant
Det finns två typer av nycklar.
“Production keys”, dessa nycklar används för att anropa API:ernas “Production endpoint”
“Sandbox keys”, dessa nycklar används för att anropa API:ernas “Sandbox endpoint”
Logga in på Developer Portal med den användare (t.ex. WSO2_OpenE) som skall prenumerera på APIet
När du är inne på WSO2 API Manager Developer Portal och fliken “Applications” så kan du se alla tillagda användare.Klicka på den användare du vill skapa nycklar till.användarens applikation (DefaultApplication)
Välj Action “Edit” för DefaultApplication och klicka på “Save” utan att förändra någon information
Välj antingen “Production keys” eller “Sandbox keys” i flikarna till vänster beroende på vilken typ av nycklar du vill skapa.
Välj antingen “Oauth2 Tokens” eller “Api Key” beroende på vilken säkerhetstyp du valde på ditt API.
För OAuth2 Tokens:
Verifiera att alternativet “Client Credentials” är ikryssad vid rubriken “Grant Types”. Det är denna metod som klienten ska använda för att hämta access nyckel.
Klicka på “GENERATE KEYS”
Du ser nu en “Access Token”, denna behöver du inte. Så klicka på “CLOSE”.
Nu kan du se “Consumer Key” och “Consumer Secret”. Klicka på kopieringssymbolen i dessa fält och spara dessa på en säker plats. Dessa ska vi skicka till konsumenten på ett säkert sätt i nästa steg.
För API Key:
Klicka på “GENERATE KEY”
Du ser nu en genererad API Key, klicka på kopieringssymbolen till höger om fältet och spara denna på en säker plats. Denna nyckel ska vi skicka till konsumenten på ett säkert sätt i nästa steg.
...
Surfa in på webbadressen till WSO2 API Manager Developer Portal, denna adress slutar på: /devportal
Gå in på fliken “Applications”.
Gå in på den användare du vill generera en access token för.
Välj antingen att gå in på “Production Keys” eller “Sandbox Keys”.
Gå sedan in på “Oauth2 Tokens”.
Klicka på knappen “GENERATE ACCESS TOKEN”.
Klicka på “GENERATE”.
Du kan nu se din access token. Kopiera denna.
I Postman, gå in på fliken “Headers” i ditt anrop.
Byt ut värdet på din “Authorization”-header. Den ska bestå av: “Bearer <din nya access token>”
Nu ska anropet fungera igen.
...