Getting started

• Introduction
  • Subscribe to the API
  • API Authentication
  • API Description
    • Summary of resources
    • Summary of methods and URL
    • Retrieve QoS Profile information
    • Request a session
      • Summary of request body parameters
      • Summary of response body parameters
      • Example (from msisdn)
    • Most frequent errors
    • Retrieve a session
      • Summary of request parameters
      • Summary of response body parameters
      • Example
    • Most frequent errors
    • Delete a session
      • Summary of request parameters
      • Summary of response
      • Example
    • Send session notification
      • Summary of session notification body parameters
      • Summary of response
      • Example
  • History of document

Introduction

The CAMARA Quality on Demand API provides a standardized mechanism for requesting, retrieving and terminating a mobile connectivity session with improved performance (bandwidth and latency).

When an application on a mobile device triggers an enhanced QoD it has to provide expected quality of service (qos) profile between the user equipment (ue) and the application server (as). It may also provide a requested duration, ports, and a notification url.

The QoD server will (if provided) sent a notification to this notification url when the session terminated. In future release we can add other notification type.

Subscribe to the API

You get the Authorization header credentials when you register your application on the Orange Developer Console.

API Authentication

HTTPS requests to the REST API are protected with 2-Legged OAuth. To learn more about how Orange Developer handles authentication, please refer to our documentation.

In short, you will use your Orange Developer Authorization header as authorization_header for the Basic authentication with Orange Developer.

curl -X POST \
-H "Authorization: {{ authorization_header }}" \
-d "grant_type=client_credentials" \
https://api.orange.com/oauth/v3/token

In response, you will get an access_token.

{
       "token_type": "Bearer",
       "access_token": "66AeYJF8eJQ...2SjkFg9LB1LePC",
       "expires_in": "3600"
}

Go up

API Description

Summary of resources

This API has two resources managed by QoD server: sessions and qos-profiles .

• qos-profiles are the profiles managed by Orange server. A profile is list of technical attributes defining quality on demand performance. This could be considered as 'catalog' information.
• sessions is a quality on demand session requested to Orange server between a device (defined by IP address & port) to an application on a server (defined by IP address & port). A session request MUST provides both device/application information but also the qos-profiles wished.

API consumer mays provide in POST /sessions a callback URL on which notifications (eg. session termination) regarding the session can be received from the service provider. The notification will be sent to this URL and accordingly to the OAS callback definition

Summary of methods and URL

As QoD session requester:

As QoD Server:

Go up

Retrieve QoS Profile information

The operation GET "https://api.orange.com/camara/quality-on-demand/orange-lab/v0/qos-profiles allows to get all Qos Profile managed by Orange server.

An array of QoS profile is provided in the response. for each QoS profile following information are provided:

Rate type is defined as following:

Duration type is defined as following:

It is also possible to query all information for one QoS profile id by using operation GET "https://api.orange.com/camara/quality-on-demand/orange-lab/v0/qos-profiles/{name}

Request a session

Summary of request body parameters

Following table provides details about device:

Note: One identifier of the four must be provided.

Following table provides details about device Ipv4 address:

Note: publicAddress must be provided with either privateAddress or publicPort.

Following table provides details about applicationServer:

Note: One identifier of the two must be provided.

Following table provides details about webhook:

Go up

Summary of response body parameters

All in the request plus following attributes:

Message object features 2 mandatory attributes:

• severity: for message severity - mandatory and a string enum with value INFO and WARNING
• description: for detailed message text - a mandatory string.

Qos status definition: The status can be one of the following:

• REQUESTED: Qos has been requested by creating a session,
• AVAILABLE: The requested QoS has been provided by the network
• UNAVAILABLE : The requested QoS cannot be provided by the network due to some reason

Go up

Example (from msisdn)

Request:

curl -X POST "https://api.orange.com/camara/quality-on-demand/orange-lab/v0/sessions"
-H "Authorization: Bearer {your access token}"
-H "Cache-Control: no-cache"  
-H 'accept: application/json'
-H 'Content-Type: application/json'
-d  '{
{
    "duration": 600,
    "device": {
        "ipv4Address": {
            "publicAddress": "172.20.120.105",
            "privateAddress": "172.20.120.105"
        }
    },
    "applicationServer": {
        "ipv4Address": "172.20.120.84"
    },
    "devicePorts": {
        "ports": [
            50984
        ]
    },
    "applicationServerPorts": {
        "ports": [
            10000
        ]
    },
    "qosProfile": "b55e2cc8-b386-4d90-9f95-b98ba20be050",
    "webhook": {
        "notificationUrl": "https://webhook.site/.....-b450-cfffc51b4c13"
    }
}
}

Response:

201 Session created
Content-Type: application/json

{
    "duration": 600,
    "device": {
        "ipv4Address": {
            "publicAddress": "172.20.120.105",
            "privateAddress": "172.20.120.105"
        }
    },
    "applicationServer": {
        "ipv4Address": "172.20.120.84"
    },
    "devicePorts": {
        "ports": [
            50984
        ]
    },
    "applicationServerPorts": {
        "ports": [
            10000
        ]
    },
    "qosProfile": "b55e2cc8-b386-4d90-9f95-b98ba20be050",
    "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "webhook": {
        "notificationUrl": "https://webhook.site/.....-b450-cfffc51b4c13"
    },
    "startedAt": 1639474600,
    "expiresAt": 1639478200,
    "qosStatus": "REQUESTED"
}

Go up

Most frequent errors

If a session is already existing for the same device an error 409 will be sent

HTTP/1.1 409 Conflict
Content-Type: application/json
{
{
  "code": "CONFLICT",
  "status": 409,
  "message": "Another session is created for the same device"
}
}

There are some cases where your client application will no longer gain access to API resources, and get an error back.

Please check the following points:

• Here, you attempt to use an expired or revoked access_token and you get an invalid token error. You will have to request a new access_token. As an example:

HTTP/1.1 401 Unauthorized
Content-Type: application/json
{
  "code": "UNAUTHENTICATED",
  "status": 401,
  "message": "Authorization failed: ..."
}

• Here, you removed your subscription to the API so that the capability to generate an access_token is not allowed anymore. As an example:

HTTP/1.1 403 Forbidden
Content-Type: application/json
{
  "code": "PERMISSION_DENIED",
  "status": 403,
  "message": "Operation not allowed: ..."
}

Go up

Retrieve a session

Summary of request parameters

Only id must be provided as parameter path.

Summary of response body parameters

If session is still existing a complete sessions representation is provided in the response with code 200. See parameters definition for POST request/response.

Example

Request:

curl -X GET "https://api.orange.com/camara/quality-on-demand/orange-lab/v0/sessions/3fa85f64-5717-4562-b3fc-2c963f66afa6"
-H "Authorization: Bearer {your access token}" 
-H 'accept: application/json'

Response:

200 Contains information about active session
Content-Type: application/json

{
  "duration": 3600,
  "device": {
        "ipv4Address": {
            "publicAddress": "172.20.120.105",
            "privateAddress": "172.20.120.105"
        }
    },
  "devicePorts": {
        "ports": [
            50984
        ]
    },
  "applicationServer": {
    "ipv4Address": "192.168.0.1/24"
  },
  "applicationServerPorts": {
    "ports": [
      10000
    ]
  },
  "qosProfile": "b55e2cc8-b386-4d90-9f95-b98ba20be050",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "startedAt": 1639474600,
  "expiresAt": 1639478200,
  "qosStatus": "REQUESTED",
  "webhook": {
        "notificationUrl": "https://webhook.site/.....-b450-cfffc51b4c13"
    }
}

Go up

Most frequent errors

Error is 404 is session did not exist

HTTP/1.1 404 Session not found
Content-Type: application/json
{
  "code": "NOT_FOUND",
  "status": 404,
  "message": "Session Id does not exist"
}

Delete a session

Summary of request parameters

Only id must be provided as parameter path.

Summary of response

If deletion performed a 204 Session deleted is sent as a response (without body)

Example

Request:

curl -X DELETE "https://api.orange.com/camara/quality-on-demand/orange-lab/v0/sessions/3fa85f64-5717-4562-b3fc-2c963f66afa6"
-H "Authorization: Bearer {your access token}" 
-H 'accept: application/json'

Response:

204 Session deleted

Go up

Send session notification

Important: this endpoint is to be implemented by the API consumer. The QoD server will call this endpoint whenever any network related event occurs.

QoD server will use notificationUrl and notificationAuthToken as provided in the request.

Summary of session notification body parameters

The following table provides details about eventDetail structure:

Summary of response

If notification is successfully received, a 204 Successful notification is expected as a response (without body)

Example

Request:

curl -X POST "https://{notificationUrl}/notifications"
-H "Authorization: Bearer {notificationAuthToken}"
-H "Cache-Control: no-cache"  
-H 'accept: application/json'
-H 'Content-Type: application/json'
-d  '{
  "eventType": "QosStatusChangedEvent",
  "eventDetail": {
    "sessionId": "8ed2b561-d64c-48ec-bb92-d60421a0147c",
    "qosStatus": "AVAILABLE"
  }
}

Response:

```json
204 Successful notification

History of document

Go up