KPN

Disturbance Detector - KPN

KPN

Retrieve an overview of all network disturbances within the Netherlands

A complete and reliable list of network disturbances

  • Network

API reference on SwaggerHub

Introduction

The Disturbance Detector API allows you to get an overview of all disturbances in the KPN network in the Netherlands.

Conceptual model

Conceptual model

API workflow

Sequence diagram

Getting started

Authentication

To authenticate you'll need to request an access token. Use your API Store app's credentials (Consumer Key and Consumer Secret) to make an authentication request. The authorization service returns a JSON message that contains the access_token field.

Use one of the following 3 options:

cURL

Execute below cURL command to receive an access token. Replace APP_CONSUMER_KEY and APP_CONSUMER_SECRET with your app's credentials.

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'

If you are using cURL for Windows, please use the command below instead.

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 authentication 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": "6e38edxxxxxxxxxxxxxxxx4065d79c",
    "scope": "",
    "expires_in": "3599",
    "refresh_count": "0",
    "status": "approved"
}

SwaggerHub

  1. Click on the Authorize button on the top right.
  2. In the form, fill in client_id and client_secret, using your app's credentials.
  3. Click Authorize.

Postman

When using Postman, you will have to import the Swagger file into a Postman collection as follows:

  1. Open the API reference on SwaggerHub.
  2. On the top right, click Export, click Download API and click 'YAML Unresolved'.
  3. In Postman from the menu click File and click Import... Choose the YAML file you downloaded in the previous step. A new collection will be added.
  4. Select Get Access Token from the collection.
  5. Make sure the right environment is selected, corresponding to the API.
  6. Edit the environment variables client_id and client_secret, using your app's credentials.
  7. Check the response code and message.
  8. Press the Send button to get an access token.

Note: Request variables are no longer linked to an environment, but to the collection.

How to...

Detect network disturbances

SwaggerHub:

  1. Check disturbance GET /failures.
  2. Click Try it out.
  3. Supply state.
  4. Click Execute.
  5. Check the response code and message.

Postman: 1. Request GET (DetectDisturbance). 2. Supply state. 3. Click Send. 4. Check the response code and message.

the result of the call will look like the following:

[
    {
        "id": 1212,
        "affected_elements_count": 3,
        "affected_customers_count": 549,
        "communicated_customers_sms_count": 348,
        "communicated_customers_email_count": 200,
        "type": "geographical-broadband",
        "cause": "disturbance",
        "source": "gui",
        "service": null,
        "state": "open",
        "start_date": "2017-06-29T12:29:06Z",
        "end_date": "2017-06-29T09:27:05Z",
        "region": "Woerden",
        "description": null,
        "long_description": "<p>Auto-generated long_description field for geographical-broadband. This is an geographical failure. testing123</p>",
        "serviceguard_ticket_id": "gtgyyg",
        "created_at": "2017-06-29T12:29:06Z",
        "communication_type": null,
        "user": null
    },
    ...
    ...
    ...
]

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