Qodex.ai

MockUp [MobileServicesManagement-KPN]

Number of APIs: 66

revision 1.1 - How to use the mock up of the Mobile Service management APIs

Introduction

The Mobile Service Management API allows you to manage your corporate fleet of mobile devices and subscription with KPN Mobile.
This API consist of a set of tools to order, provision, maintain and configure mobile phones from KPN.

Need For Mockup APIs

The sandbox environment of the Mobile service management API is deprecated. To fill the gap in the test environment, we have created mockup APIs. These mockup API is limited to a few use cases though.

Scope of Mockup:

The scope of the Mockup API is limited to the following use cases.

  • 02 - Activate Sim card - New Mobile with ordering physical sim

  • 02- Activate Sim card- From Stock

  • 02- Activate Sim card- eSIM

  • 03- Block SIM card

  • 04- UnBlock SIM card

  • 05 - Change User Data

  • 06- Change End-user Network Services

  • 07- Terminate Subscription

  • 09- Port Number Out

  • 10 - Replace Sim

  • 10 - Replace eSim

  • 13- create Subscriber - Without MijnKPN Zakelijk account

  • 13- create Subscriber - With MijnKPN Zakelijk User

Limitation of Mockup:

  • The request-response of the mockup API is static, and it's not real-time data.

  • The data used in the mockup services are dummy and pre-populated, dont chnage it .

  • It mimics the API experience via the KPN Developer Portal

Prerequisite for the Mockup:

  • Step 1: Registered account with KPN Developer Portal

  • Step 2: Request for access to the " Mobile Service Management API.

  • Fork the collection to your Qodex workspace. You can follow the steps mentioned here

API specification

Test the API on SwaggerHub

Base URL

Base URL

Qodex collection link :

Getting started

Make sure you've read the page

What's in it for you

for more info on how to register and start testing APIs.

Authentication

The API follows the KPN Store API Authentication Standard to secure the API. It includes the use of OAuth 2.0 client_id and client_secret to receive an access token.

Please note that the authentication URL to retrieve a token, is different for this specific API. The URL for this Mobile Service Management API is:

https://api-prd.kpn.com/oauth/grip/msm/accesstoken?grant_type=client_credentials

How to...

Step 1: Update your client Credentials (Client_id and client_secret) on the Variable section as shown below.

Update your client credentials

Step 2: Generate an Access token using the GetAccessTokenComarch resource, as shown below.

Generate Access Token

Step 3: Make a call to the APIs to experience the APIs. Request data is pre-populated. Just a send Command will work.

Note: Request Data is already populated; please don't change it. If you change the request data apart from the access token, the Mockup APIs will not work correctly.

Following are the two examples of Pre-populated data on the Mock Up Collection

Example 1: Post Calls

Query Param data: Add mobile product to Basket:

Headers data: Add mobile product to Basket :

Payload : Add mobile product to Basket :

Response data: Add mobile product to Basket :

Example 2: Get calls

Find all subscribers whom user manages:

Get basket content with products tree and prices:

Get list of main products to order :

  1. 02 - Activate Sim card - New Mobile with ordering physical sim - 1- Find all subscribers whom user manages GET {{baseUrl}}/hierarchy/subscribers

  2. 02- Activate Sim card- From Stock - 1- Find all subscribers whom user manages GET {{baseUrl}}/hierarchy/subscribers

  3. 02 - Activate Sim card - New Mobile with ordering physical sim - 6- Get list of main products to order GET {{baseUrl}}/contracting/basket/main-products?from=0&to=10&order=ASC&sortBy=PRODUCT_NAME&category=sim cards

  4. 02 - Activate Sim card - New Mobile with ordering physical sim - 7- Add mobile product to Basket POST {{baseUrl}}/contracting/basket?sessionId=334caa-1122-3344-5566-aabb12345

  5. 02 - Activate Sim card - New Mobile with ordering physical sim - 7- Get basket content with added sim card in it GET {{baseUrl}}/contracting/basket?sessionId=334caa-1122-3344-5566-aabb12345

  6. 02 - Activate Sim card - New Mobile with ordering physical sim - 8- Create order from basket POST {{baseUrl}}/contracting/basket/order?sessionId=334caa-1122-3344-5566-aabb12345

  7. 02 - Activate Sim card - New Mobile with ordering physical sim - 9- Track Order status GET {{baseUrl}}/track-and-trace/orders/:id

  8. 02- Activate Sim card- From Stock - 3- Get list of main products to order GET {{baseUrl}}/contracting/basket/main-products?sessionId=334caa-1122-3344-5566-ccdd12345&category=MOBILE

  9. 02- Activate Sim card- From Stock - 5- Get basket content with products tree and prices GET {{baseUrl}}/contracting/basket?sessionId=334caa-1122-3344-5566-ccdd12345

  10. 02- Activate Sim card- From Stock - 6- Set SIM card number from stock in basket POST {{baseUrl}}/contracting/basket?sessionId=334caa-1122-3344-5566-ccdd12345