How to start with Orange Developer

This page allows you to get familiar with the Orange Developer website, so that you can subscribe to and easily integrate an API. To do so, follow the steps described below.

Discover our catalog

The Orange Developer website presents all APIs published by the Orange Group. The whole catalog is found here: Catalog of all APIs. You can explore the full range of APIs to identify the product that best meets your requirements. Each API product features:

• an overview, outlining its usage and potential use cases, the geographical area where it is available,…
• a Getting Started section, including instructions for testing and utilizing the API,
• the Open API (Swagger) reference documentation to facilitate seamless integration.
• Other types of information, depending on the API: an FAQ, specific Terms and conditions, release logs…

Choose your API

1. Click Products > All APIs. You reach the API catalog page:

2. Use the filters on the left to display the APIs that meet your needs, in our example Communications:

3. Click an API. You reach the Overview of this API:

In this guide, we will take the SMS API as an example.

3. As described in the Overview, choose the country for which you want to integrate the API. You reach the following page:

On the left-hand menu, you can access the Getting Started guide, the API Reference, etc.

4. Click Use this API in the top menu. You are redirected to the Log in / Register page:

Create an account

If you already have an account:

1. Specify:
   • your e-mail address,
   • your password,
2. click Submit. You are redirected to the MyApps dashboard.

If you do not have an account yet:

1. Click Register. The account creation page appears:

2. Fill in all necessary fields and click Submit.

Make sure you use the same e-mail address throughout the whole process

The following confirmation message appears:

3. Click the link inserted in the mail you have just received:

Your Orange Developer account is activated and fully functional. You now need to create an application, as described below.

Create an application

1. In MyApps, in section Create a new application, enter:

• The Application name
• A description for your application

2. Click Create. Your application is created.

Once your application is created, you have access to:

• In tab Summary: your application ID
• In tab Credentials: your Client ID and Client Secret
• In tab Settings: the settings applicable to your application
• The list of APIs, to which you have requested to subscribe
• A menu to configure, get status and remove an API

Obtain your access token

In the Credentials tab:

1. Click Show

2. Enter the password of your Orange Developer account when prompted

3. Copy the content of fields Client ID, Client secret and Authorization header

From now on, you may use your favorite IDE tool and proceed so that the information below is properly taken into account

4. Enter the information provided in the cURL code below:

curl -X POST
-H "Authorization: {authorization_header}" 
-H "Content-Type: application/x-www-form-urlencoded"
-H "Accept:application/json"
-d "grant_type=client_credentials"
https://api.orange.com/oauth/v3/token
        
        Copied 
      

5. Replace {authorization_header} with your own header info. The code should look like:

curl -X POST
-H "Authorization: Basic emRDY1JlWFlTNXF6ZVI2VXJvdmIwN....nWWI6bkpURXlyUkoxaFFYUEc1UQ==" 
-H "Content-Type: application/x-www-form-urlencoded"
-H "Accept:application/json"
-d "grant_type=client_credentials"
https://api.orange.com/oauth/v3/token
        
        Copied 
      

6. Send your request. The token appears in the query response, such as shown below:

{ "token_type": "Bearer", "access_token": "eyJO 5SLvVOk3E....AA1iUFJGcG2GQe", "expires_in": 3600 }
        
        Copied 
      

This token is used for all APIs you want to connect to. For more information on using the access token, see the guides In a nutshell in section Recommended for you below.

Consume an API

1. In your IDE, enter your token information:

-H "Authorization: Bearer {access_token}"
        
        Copied 
      

2. Then use an API request. In our example:

curl -X POST -H "Authorization: Bearer {{access_token}}" \
-H "Content-Type: application/json" \
-d '{"outboundSMSMessageRequest":{ \
        "address": "tel:+{{recipient_phone_number}}", \
        "senderAddress":"tel:+{{country_sender_number}}", \
        "outboundSMSTextMessage":{ \
            "message": "Hello!" \
        } \
    } \
}' \
"https://api.orange.com/smsmessaging/v1/outbound/tel%3A%2B{{country_sender_number}}/requests"

        
        Copied 
      

3. You receive the following answer:

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8
[
  {
     "outboundSMSMessageRequest": {
     "address": "tel:+00",
     "outboundSMSTextMessage": {
      "message": "AAAAAA"
     },
     "senderAddress": "tel:+00",
     "senderName": "string"
   }
  }
]
        
        Copied