overview
|
The Authentication API alpha is part of the Personal APIs suite and has two different purposes:
Firstly, it enables basic authentication and privacy functionality, so must be used before you use any of the other APIs.
Secondly, it simplify access to your website for Orange users by allowing them to use their existing Orange account credentials.
This is done with the customer's knowledge and consent and is applicable to registered users of www.orange.fr
|
|
Use this API to automatically authenticate Orange customers to your web service.
In a nutshell, the Authentication API enables you to:
access other Personal APIs in the suite by using basic authentication and privacy functions.
simplify access to your website by allowing users to use their existing Orange account
credentials.
The diagram below illustrates the role of the API:

technical features
The Authentication API is compliant with SAML v2 protocol.
The Security Assertion Markup Language (SAML) is an XML standard for exchanging authentication and authorisation data between security domains, that is, between an identity provider (a producer of assertions) and a service provider (a consumer of assertions).
SAML is a set of specifications produced by OASIS, which is a major standardisation body in web services field. The complete SAML v2 is complex but you won't need to fully implement it as the Authentication API is based on the simplest SAML v2 profile (SAML v2 Web SSO profile).
You just need to create the SAML request using existing libraries or directly using XML document creation, and for the SAML response, you just have to parse the XML document to get the information you need.
pricing
Currently, the API is in alpha mode, and is part of the Personal APIs alpha suite.
This means that it's FREE to use with some service limitations (as you would expect).