de quoi s'agit-il ?

Les applications qu'il est possible de développer grâce à ces Personal APIs peuvent apporter une valeur ajoutée considérable aussi bien à vous - le développeur - qu'aux utilisateurs de vos applications.

Osez l'innovation et combinez les différentes API dans votre application pour créer un service unique.

En un mot, la  suite Personal APIs réunit les API suivantes :

L'Authentication API L'Authentication API a deux fonctions distinctes : Premièrement, elle permet la mise en œuvre des fonctionnalités de base d'authentification et de respect de la vie privée, et doit par conséquent être utilisée avant toute autre API. Deuxièmement, elle simplifie l'accès des utilisateurs Orange à votre site Web en leur permettant d'utiliser les identifiants de leurs comptes Orange existants.  Offrez à vos visiteurs une expérience utilisateur améliorée en ligne.   Augmentez la quantité de temps que les visiteurs passent sur votre site.  Stimulez le trafic vers vos services Web / WAP.  en savoir plus et tester

La Personal Calendar API La Personal Calendar API fournit à votre application un accès en temps réel aux calendriers des clients d'Orange France, vous permettant ainsi de visualiser les événements qui y sont inscrits et d'y ajouter de nouvelles entrées avec leur permission. L'API offre un accès sécurisé et contrôlé au calendrier de l'utilisateur.  Donnez à vos visiteurs l'accès à leurs calendriers.  Augmentez votre taux de fréquentation. en savoir plus et tester

La Personal Contacts API La Personal Contacts API fournit à votre application un accès en temps réel aux listes de contacts des clients d'Orange France, vous permettant ainsi de visualiser leurs carnets d'adresses et d'y ajouter de nouvelles entrées, avec leur permission. L'API offre un accès sécurisé et contrôlé aux listes de contacts de l'utilisateur.  Offrez à vos visiteurs un moyen facile d'ajouter de nouvelles entrées à leurs listes de contacts.   Diminuez la quantité de temps passée à rentrer des informations dans un formulaire. en savoir plus et tester

La Personal Messages API La Personal Messages API fournit à votre application un accès en temps réel aux messageries des clients d'Orange France, leur permettant ainsi d'être prévenus des e-mails qu'ils reçoivent à tout moment. Et bientôt, ils pourront consulter leurs SMS, MMS et bien d'autres choses encore... L' API offre un accès sécurisé et contrôlé aux contacts de l'utilisateur.  Offrez à vos visiteurs une expérience utilisateur enrichie.   Informez vos utilisateurs des messages qu'ils ont reçus. en savoir plus et tester

La Personal Photos API La Personal Photos API fournit à votre application un accès en temps réel aux albums photos des clients, vous permettant ainsi de visualiser leurs photos et d'y ajouter de nouvelles avec leur permission. L'API offre un accès sécurisé et contrôlé aux albums photos  Orange de l'utilisateur.  Rechercher et extraire les informations sur les albums et les photos à partir du compte photos Orange de l'utilisateur, ainsi que des liens vers les photos.   Importer des photos dans les albums photos Orange existants ou nouvellement créés. en savoir plus et tester

La Personal Profile API La Personal Profile API fournit à votre application un accès en temps réel aux informations de profil des clients d'Orange France, vous permettant ainsi de rechercher et d'extraire des données telles que le nom, l'e-mail, l'adresse, le numéro de téléphone, etc. avec leur permission. L'API offre un accès sécurisé et contrôlé au profil de l'utilisateur.  Rechercher et extraire les informations de profil des clients d'Orange France. en savoir plus et tester

(haut de page)

deux choses à faire avant de commencer

Vous avez juste deux étapes à suivre avant de commencer...
 

	Vous devez être membre d'Orange Partner pour pouvoir utiliser  les Personal APIs et accéder à l'administrator web interface. Si vous ne l'êtes pas déjà, devenez membre d'Orange Partner dès maintenant
	Une fois votre session ouverte sur le site d'Orange Partner, accédez à l'administrator web interface et inscrivez-vous aux API.

(haut de page)

Ces informations nous aideront à valider votre inscription.
Les informations que vous nous fournirez sur le site Web seront communiquées aux utilisateurs pour leur permettre de définir leurs paramètres en matière de respect de la vie privée et de déterminer s'ils vous autoriseront, vous, le développeur, à accéder à leurs informations personnelles via les Personal APIs.

Vous aurez ensuite accès à un écran vous permettant de solliciter une inscription à n'importe laquelle des API.

Souvenez-vous que vous DEVEZ d'abord vous inscrire à l'Authentication API.

Une fois votre inscription validée, vous recevrez un e-mail et un fichier ZIP contenant les éléments suivants :

 Votre clé d'accès (SERVICE_ID et SERVICE PWD)
 L'URL de l'API (point de terminaison HTTP)
 Les exemples de codes
 Les instructions d'utilisation relatives à tous ces éléments.

(haut de page)

comment vos services interagissent-ils avec les API ?  

Étant donné que les API fournissent des informations sensibles et personnelles sur nos clients, nous devons veiller à ce que ces dernières ne soient pas utilisées sans leur consentement.

Afin d'accéder à la suite Personal APIs, votre service en ligne doit obtenir l'authentification de l'utilisateur et son consentement pour l'utilisation de ses informations personnelles.

Le diagramme ci-dessous est une illustration simplifiée des interactions générales entre les différentes entités :

Les interactions nécessitent l'utilisation de la redirection HTTP. Veuillez vous reporter à la page du protocole W3C si ces mécanismes ne vous sont pas familiers.

Le processus pour accéder à une Personal API est le suivant ::

Notez que pour des raisons de sécurité, votre service doit prendre en charge le protocole S-HTTP (HTTPS) pour utiliser les Personal APIs.

(haut de page)

plus d'informations sur les principes de respect de la vie privée 
 

Lorsque des informations personnelles sur un client d'Orange France sont demandées via une Personal API, une exception « respect de la vie privée » peut se produire  si le client n'a pas encore donné son consentement (consultez la section ci-dessous sur les codes d'erreur généraux).

Le message d'exception « respect de la vie privée » contient une URL vers une page « respect de la vie privée » vers laquelle vous pouvez rediriger l'utilisateur pour obtenir son consentement.

Lorsque l'utilisateur arrive sur la page de « respect de la vie privée », 3 choix s'offrent à lui :
 Accorder à votre service l'accès un accès uniquepour cette fois seulement à ses  à un ensemble particulier de données.
 Accorder à votre service un l'accès permanent à un ensemble particulier deà ses données (jusqu'à ce qu'il change d'avis).
 Refuser à votre service l'accès à un ensemble particulier deses données.

Ensuite, l'utilisateur sera redirigé vers une page spécifique de votre site Web où vous pourrez à nouveau appeler la Personal API.

Selon le choix précédent de l'utilisateur, vous pourrez ou non accéder à ses données.

Le diagramme ci-dessous présente une vue d'ensemble du parcours de l'utilisateur :

(haut de page)

commencez votre développement
 

Pour expliciter un peu plus la façon dont les Personal APIs interagiront avec votre service, nous avons créé des diagrammes de séquences qui illustrent les différentes interactions. Les deux principaux scénarios sont illustrés.

 scénario principal
 scénario « respect de la vie privée »
 

(haut de page)

codes d'erreur généraux pour les Personal APIs

Lors de l'utilisation de la suite Personal API, vous êtes susceptibles de recevoir un code d'erreur en retour, indiquant que vous devez soit interagir avec l'Authentication API soit rediriger l'utilisateur vers l'URL « respect de la vie privée » avant que votre service n'appelle la suite Personal APIs.

code	détail	commentaire
-1	InvalidTokenException	Vérifiez le jeton de l'utilisateur, utilisez l'Authentication API pour renouveler ce jeton d'utilisateur.
-2	ServiceEnablerNotFoundException	Vérifiez le point de terminaison HTTP et les paramètres de la requête.
-3	PrivacyAccessDeniedException	L'utilisateur n'a pas encore autorisé votre service à accéder à cette information. Rediriger l'utilisateur vers la page d'interaction « respect de la vie privée ».
-4	MetaEnablerException	Erreur du serveur  interne, merci de nous contacter

 exemples de réponses d'erreurs

La réponse pour le code d'erreur « -1 » est dans leau format suivant :

La réponse pour le code d'erreur « -3 » est dans leau format suivant :

Le paramètre <url> contient l'URL de la page « respect de la vie privée » qu'il est nécessaire d'utiliser pour inviter l'utilisateur à donner son consentement pour l'accession aux données requises par la Personal API.

Pour inviter l'utilisateur à donner son consentement, votre service doit le rediriger vers le paramètre <url> concaténé avec votre URL de retour.

Par exemple, si votre URL de retour est « http://myservice.com/displaypage.php » - il vous faudra rediriger l'utilisateur vers l'URL suivante :

Après cette interaction, l'utilisateur est redirigé vers votre URL de retour où vous pourrez appeler à nouveau la Personal API.

(haut de page)