Skip to main content

Orange Developer - Getting started

This page provides essential information about authentication and accessing Evolution Platform - Console resources via API. To do so, follow the steps described below.
These steps must be followed in the order described, or you won’t be able to properly use the API!

1. Request X-API-Key​

Request your Orange Business representative to get your personnal API Key. This API key is linked to you Orange developper Account.

It is a unique API key that is generated for each authorized user or application accessing the API.

When you send an API request, you must include the X-API-Key header with your unique API key value. This allows Evolution Platform to verify your identity and authorize your access to the requested resources.

CAUTION

Using X-API-Key helps to keep your data secure and confidential during the communication between your application and Evolution Platform.
It's important to keep your API key private and not share it with anyone unauthorized to prevent any misuse or unauthorized access to the API.

2. Get your access token​

Access to APIs are 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 APIs.

info

It assumes that you already completed the setup access procedure to get you access token.
If not, click on the button below to get your access token:

3. Access the protected resources​

To make an API call, both an bearer access token and an X-API-Key are required:

  • The bearer access token must be provided in the request using HTTP Authorization header.
  • The X-API-Key must be provided in the request using X-API-Key HTTP header.

Example:

curl -X GET \
-H "Authorization: Bearer i6m2iIcY0SodWSe...L3ojAXXrH" \
-H "X-API-KEY: abcdef12345" \
https://api.orange.com/evolutionplatform/referentiel/api/v1/organizations

If your client application attempts to use an expired or revoked access token, an invalid token error is returned.

Response:

HTTP 200 (OK)

Content: application/json

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "customerId": "string",
    "customerAddress": "string",
    "type": "string",
    "installedOfferList": [
      {
        "code": "~",
        "name": "0"
      }
    ],
    "salesContactName": "string",
    "salesContactEmail": "string",
    "tanid": 0,
    "contractid": 0,
    "saleschannel": "string",
    "banIds": [
      0
    ],
    "linkedCustomerIds": [
      "string"
    ]
  }
]

4. Guides and Tutorials​

Discover guides and tutorials aimed at enhancing your understanding of utilizing APIs powered by Evolution Platform.