Monitoring EVPL 1.0

Table of Contents

• Introduction
• Prerequisites
• Subscribe to the API on the Orange Developer website
• Check the other prerequisites
• Start using the API
• Generate a token
• Find your Metrics
• API Error handling
• Get the status of the API
• Postman collection to download
• Using Postman on your PC or Mac
• Support

Introduction

The “EVPL Monitoring” project was designed to provide you with enhanced visibility into your Ethernet Virtual Private Line (EVPL) services. Thanks to the integration of the Monitoring API into your information system (IS), you will be able to monitor the performance of your EVPL services in real time independently.

To access the metrics of your EVPL offer, simply specify your operator code as well as the offer concerned. From this information, a request will be sent to our systems to retrieve the list of products linked to this offer. Then, calls to the API will be made for each LD (Product), which will allow you to access the specific metrics of your EVPL offer.

This project is designed to give you accumulated control and a better understanding of the performance of your services, allowing you to quickly react to variations and optimize the management of your network infrastructures.

Prerequisites

To retrieve your operator code, please access to your bill invoice and below the format :

Subscribe to the API on the Orange Developer website

• We have sent you an email inviting you to discover the Orange Wholesale International Trouble tickets API (Sandbox). The Sandbox version is connected with our test environment. It allows you to test the API before using it on production.

• Open the link included in the email. You'll be asked to create or sign up to your Orange Developer account.

• Click on the Use this API button

• Select an existing app or create a new one. You can name the app as you like and insert your codeOp.

• Click on the Next button. Your subscription to the API will be automatically approved.

Check the other prerequisites

• Your Orange Wholesale International representative will set up your access to the eCare customer portal

• You'll be provided an ApplicationID. (Different from the one you see on your Orange Developer account)

• You'll also need your client_id and client_secret that can be found on your Orange Developer account in My apps section.

Start using the API

Generate a token

Access to this API is secured by the OAuth 2.0 framework with the Client Credentials grant type, which means that you will have to present an OAuth 2.0 access_token whenever you want to request this API.

It's easy to negotiate this access_token: just send a request to the proper token negotiation endpoint, with a Basic Authentication header valued with your own client_id and client_secret.

For this API, the token negotiation endpoint is:

https://api.orange.com/oauth/v3/token

        
        Copied 
      

A technical guide is available to learn how to negotiate and manage these access_token.

Find your Metrics

Request

• Method : GET
• URL: https://api.orange.com/api-monitoring-live/v1/pm_jobs/JOBV/reports/UTILIZATION
• Authorization : OAuth 2.0 authentication to get the access token
• Header : ApplicationID, pagination (The index of the first element to retrieve. One is the first item of the collection)

The API provides a filter mechanism with the following query parameters

• codeOpe : Code operator
• startTime : The accepted format is YYYY-MM-DDThh:mm:ss.mssZ (ex: 2023-08-28T14:40:38.041Z)
• endTime : The accepted format is YYYY-MM-DDThh:mm:ss.mssZ (ex: 2023-08-28T14:40:38.041Z)
• offer_type : The only accepted value is EVPL
• granularity : ('Xms', 'Xs', 'Xm', 'Xh', 'Xd', 'Xw', 'Xy') where X is an integer > 0 and ms, s, m, h, d, w and y respectively refer to milliseconds, seconds, months, hours, days, weeks and years. In case X is omitted, it is assumed to the value 1.
• ctxtid : The only accepted value is wse
• sctxtid : The only accepted value is vsn

Response

You will receive a code 200 with the following body :

Body

{
  "currentPage": 0,
  "totalPages": 0,
  "hasNext": true,
  "entries": [
    {
      "objectType": "string",
      "objectInstanceId": "string",
      "metric_name": "string",
      "pop_country": "string",
      "pop_name": "string",
      "pop_section_name": "string",
      "performanceValues": [
        {
          "timeStamp": "string",
          "value": "string"
        }
      ]
    }
  ]
}

        
        Copied 
      

API Error handling

• Code : 400
• Meaning : Bad request

{
  "code": 0,
  "message": "string",
  "description": "string",
  "infoURL": "string"
}

        
        Copied 
      

• Code : 404
• Meaning : Not Found

{
  "code": 0,
  "message": "string",
  "description": "string",
  "infoURL": "string"
}

        
        Copied 
      

• Code : 405
• Meaning : Method Not Allowed

{
  "code": 0,
  "message": "string",
  "description": "string",
  "infoURL": "string"
}

        
        Copied 
      

• Code : 422
• Meaning : Unprocessable entity Business error

{ 
  "code": 0,
  "message": "string",
  "description": "string",
  "infoURL": "string"
}

        
        Copied 
      

• Code : 500
• Meaning : Internal Server Error

{
  "code": 0,
  "message": "string",
  "description": "string",
  "infoURL": "string"
}

        
        Copied 
      

• Code : 503
• Meaning : Service Unavailable

{
  "code": 0,
  "message": "string",
  "description": "string",
  "infoURL": "string"
}

        
        Copied 
      

Postman collection to download

Using Postman on your PC or Mac

Here's a step-by-step guide for setting up and using the Postman collection you mentioned:

Step 1: Set Up Postman Collection

We prepared a Postman collection for you, complete with code to parse replies and manage variables.

1. Download the JSON file by clicking on the Run in Postman icon (if available).
2. Open Postman on your computer.
3. Go to the File menu, click Import, and upload the Monitoring_Collection JSON file.
4. You should now see a collection named Monitoring_Collection in your Postman.

In the next step, we will retrieve the access token needed to authorize requests.

Step 2: Retrieve Access Token

1. In the Monitoring_Collection, locate the TOKEN_Monitoring request. This is a POST request for the access token.
2. Open the Body tab and ensure x-www-form-urlencoded is selected.
3. Update the following fields with your credentials:
   • client_id
   • client_secret

4. Click Send to execute the request.

You should see a response containing an access_token. Copy this token for the next step.

Step 3: Authorize the GET Request

1. Open the GET_Metric_OD request in the Monitoring_Collection.
2. Go to the Authorization tab.
3. Choose Bearer Token as the authorization type.
4. Paste the access_token from the previous step into the Token field.

Step 4: Customize Parameters

In the GET_Metric_OD request:

1. Go to the Params section.
2. Modify any parameters as needed for your specific monitoring metrics.

When you're ready, click Send to execute the request and retrieve the data.

Support

If you experience a problem with the API integration, you need only to click on Contact us form (https://developer.orange.com/apis/api-monitoring-live/contact-us)

Go up