LKAB API Management

This wiki contains information and guides to help you getting started with the LKAB API Management platform, both as an API Developer to publish your API, as well as API consumer, to start consuming APIs via the LKAB API Management platform.

Looking for the API Portal? You find it here: API Portal

The documentation at this site is somewhat outdated regarding the onboarding of both API's and consumers.
While waiting for it to be updated, a short version of the current process for onboarding follows below.
* start of updated onboarding process *

API Onboarding

In short, to onboard an API:

Reserve an API id and basepath in the API catalog.
Run the API Onboarding pipeline

The pipeline will create:

A Product Backlog Item with subtasks on the api-management-apis board
Two App registrations (apiXXXX-yyyy-api-[test|prod]) for the API.
One App registration (yyyy-api-client-test) that can be used to test getting a token. Should not be used by a real consumer.
A GIT repository for the API configuration.

You may need to adjust the default App registrations so they suit your needs.

Consumer Onboarding

In short, to onboard an API consumer:

Run the Consumer Onboarding pipeline

Check the Create Product Backlog Item and tasks checkbox to create a PBI.
Check the Create App registrations to create App registrations for the consumer, test and prod.

Leave emails as-is to assign the user that runs the pipeline as owner for the App registrations and as assignee on the PBI.
You can specify which API's the consumer need permissions to. Use App registration display name, eg apiXXXX-yyyy-api-[test|prod]. Leave as-is if you want to manually assign permissions later.

You may need to adjust the default App registrations so they suit your needs.

* end of updated onboarding process *

Getting started

To be able to access different LKAB environments we must have a LKAB Azure AD Account. This will greatly simplify the process when assigning you to different groups and roles in the LKAB cloud environment.

LKAB/Azure Account: You should have an account with a mailbox within LKABs Azure Active Directory (Azure AD).
Account Request: If you do not already possess an account, please request one through the service desk or contact your manager.
Verify LKAB Account Navigate to your account and login with your LKAB account information. Make sure you are not logged in on another tenant in that browser window.
Join the developer@lkab team. There you can ask questions and get involved in different development activities on LKAB.

Basic concept

graph TD
  A[Client] -->|Requests API| B[APIM]
  B -->|Validates Request| C[Azure AD]
  B -->|Routes Request| D[Backend API]
  D -.->|Validates Request| C[Azure AD]
  D -->|Returns Response| B
  B -->|Sends Response| A

A client sends an API request.
Azure API Management (APIM) validates the request through Azure AD.
APIM then routes the request to the backend API.
(Recommended) The backend API validates the request through Azure AD.
The backend API processes the request and sends the response back through APIM to the client.

Platform overview

The Platform overview document is a good starting point to get an understanding of the API Management platform and the related services and processes provided by the LKAB API Management team.

Get started publishing your API

Use the documentation in this section to get started publishing your API to the LKAB API Managment platform.
Read through the guides and docs below to get an understanding of the process for publishing APIs and then contact the API Management team, by email, for a first onboarding-meeting.

Table of content

Publisher guide - This guide helps you through the workflow when deploying contract first APIs to LKAB API Management.
API catalog — A registry of all published APIs and instructions on how to assign APIs a unique id and basepath.
Pre-defined basepaths — All APIs published to the LKAB API Management SHOULD have a unique basepath. This section helps when new basepaths need to be decided/defined.
Request firewall changes - This guide helps you requesting the needed firewall changes for your api.
API App registration - This guide helps you create your API App registration
Client App registration - This guide helps you create your client App registration, i.e. the API consumer registration.

Get started consuming APIs

Use the documentation in this section to get started consuming APIs using the LKAB API Managment platform.
Read through the guides and docs below to get an understanding of the process for consuming APIs.
Need assistance? Contact the API Management team, by email.

Table of content

Consumer guide - This guide will help you getting started consuming APIs from LKAB API Management.
Client App registration - This guide helps you create your client App registration, i.e. the API consumer registration.

Contact information

Contact the API Managemenent Team by email: api.management.team@lkab.com

Links

API Portal