Aller au contenu principal

Orange Developer - Guide de démarrage

Cette page fournit des informations essentielles sur l'authentification et l'accès aux ressources de Evolution Platform - Console via API. Pour ce faire, suivez les étapes décrites ci-dessous.
Ces étapes doivent être suivies dans l'ordre décrit, sinon vous ne pourrez pas utiliser correctement l'API !

1. Demander la clé X-API​

Demandez à votre représentant Orange Business d'obtenir votre clé API personnelle. Cette clé API est liée à votre compte Orange Developer.

Il s'agit d'une clé API unique générée pour chaque utilisateur ou application autorisé à accéder à l'API.

Lorsque vous envoyez une requête API, vous devez inclure l'en-tête X-API-Key avec la valeur de votre clé API unique. Cela permet à Evolution Platform de vérifier votre identité et d'autoriser votre accès aux ressources demandées.

ATTENTION

L'utilisation de X-API-Key aide à garder vos données sécurisées et confidentielles pendant la communication entre votre application et Evolution Platform.
Il est important de garder votre clé API privée et de ne pas la partager avec des personnes non autorisées pour éviter tout usage abusif ou accès non autorisé à l'API.

2. Obtenir votre jeton d'accès​

L'accès aux APIs est sécurisé par le cadre OAuth 2.0 avec le type de subvention des informations d'identification du client, ce qui signifie que vous devrez présenter un access_token OAuth 2.0 chaque fois que vous souhaitez demander des APIs.

info

Cela suppose que vous avez déjà complété la procédure de configuration d'accès pour obtenir votre jeton d'accès.
Sinon, cliquez sur le bouton ci-dessous pour obtenir votre jeton d'accès :

3. Accéder aux ressources protégées​

Pour effectuer un appel API, un jeton d'accès bearer et une clé X-API sont nécessaires :

  • Le jeton d'accès bearer doit être fourni dans la requête en utilisant l'en-tête HTTP Authorization.
  • La clé X-API doit être fournie dans la requête en utilisant l'en-tête HTTP X-API-Key.

Exemple :

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

Si votre application cliente tente d'utiliser un jeton d'accès expiré ou révoqué, une erreur de jeton invalide est renvoyée.

Réponse :

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 et tutoriels​

Découvrez des guides et tutoriels visant à améliorer votre compréhension de l'utilisation des APIs alimentées par Evolution Platform.