KPN

Internet Speed Check - KPN

KPN

Retrieve maximum internet bandwidth and carrier types for any address

Easily check addresses in the Netherlands for free

  • Network

API reference on SwaggerHub API reference on Postman

Introduction

Find out the maximum available upload and download speed for any given address in the Netherlands. Also get insight into the technologies (copper, bonded copper or fiber) that are available for an address.

Conceptual model

General Picture

API workflow

Sequence Diagram

Getting started

Authentication

OAuth 2.0

For accessing and/or manipulating the resources, the client application (your application) needs to be granted permission to do so. The OAuth 2.0 standard defines a protocol that allows such third party authorization through the use of access tokens. Access tokens are central in the protocol. These tokens, in the form of strings, are delivered by an authorization server (our authentication server) and they enable the client application to securely access protected data on behalf of the resource owner (the end user).

We use Client Credentials Grant. This means the application makes the request to the authentication service by sending authorization credentials. The service responds with an access token among other useful information.

Get access token

Copy your app's credentials and replace APP_CONSUMER_KEY and APP_CONSUMER_SECRET with the copied values, then execute below cURL command to receive access token.

curl -X POST  'https://api-prd.kpn.com/oauth/client_credential/accesstoken?grant_type=client_credentials'  -H 'content-type: application/x-www-form-urlencoded'  -d 'client_id=APP_CONSUMER_KEY&client_secret=APP_CONSUMER_SECRET'

Note: If you are using cURL for Windows, then please use the command below.

curl -X POST "https://api-prd.kpn.com/oauth/client_credential/accesstoken?grant_type=client_credentials" -H "content-type: application/x-www-form-urlencoded" -d "client_id=APP_CONSUMER_KEY&client_secret=APP_CONSUMER_SECRET"

The authorization service returns a JSON message that contains the access token field.

{
    "refresh_token_expires_in": "0",
    "api_product_list": "[xxxxxxx]",
    "api_product_list_json": [
        " xxxxxxx"
    ],
    "organization_name": "kpn",
    "developer.email": "demo123@kpn.com",
    "token_type": "Bearer",
    "issued_at": "1521039195424",
    "client_id": "APP_CONSUMER_KEY",
    "access_token": "haf2SDl07E9N7RluNQ4kJ1TkGgso",
    "application_name": "6e38ed2d-48b1-4362-97d6-04254065d79c",
    "scope": "",
    "expires_in": "3599",
    "refresh_count": "0",
    "status": "approved"
}

How to...

Retrieve maximum internet speed and carrier type for an address

We are going to use this data as example data to call /offer endpoint (with a full path of https://api-prd.kpn.com/network/kpn/internet-speed-check/offer)

"service_address": {  
    "house_number":3,
    "zip_code":"3544ZE",
    "house_number_extension":""
}

Since it's a valid address, the alerts field will not be populated and the result of the call will look like the following:

{
    "available_on_address": {
        "technologies": [
            {
                "name": "FIBER",
                "download": 500,
                "upload": 500,
            },
            {
                "name": "COPPER",
                "download": 16,
                "upload": 2,
            },
            {
                "name": "COPPER",
                "download": 12,
                "upload": 1,
            },
            {
                "name": "NoAccess",
                "download": 0,
                "upload": 0
            }
        ],
        "house_number_extensions": [],
    },
    "max_bandwidth": {
        "up": 500,
        "down": 500
    },
    "alerts": [],
}

Return codes

Code   Description
200   Success
201   Created
202   Accepted
302   Found. Link in location header
400   Bad request
401   Unauthorized
403   Forbidden
404   Not found
405   Method not allowed
412   Precondition failed
429   Too many requests
500   Internal server error
502   Bad gateway
503   Service unavailable

Changelog

Version   Description
1.0   Initial version