avant de commencer
Avant de commencer, merci de lire les informations ci-dessous et de suivre toutes les instructions.
Vous pourrez ensuite passer à la section « pour commencer ».
deux choses à faire avant de commencer
sur l'API Manager
deux choses à faire avant de commencer
Pour commencer à tester cette API, assurez-vous d'avoir bien lu et compris la section sur les
Personal APIs (alpha) section
Ensuite, une fois dans l'API Manager, vous pourrez vous inscrire à la Personal Profile API.
sur l'API Manager
L'administrator web interface vous permet de contrôler et de configurer tous les aspects de vos inscriptions aux Personal APIs alpha.
Vous pourrez notamment :
obtenir l'autorisation d'utiliser les API
solliciter votre inscription aux APIs de votre choix
obtenir l'acceptation de votre inscription
puis recevoir votre clé d'accès, vos points de terminaison HTTP, vos exemples de code et la documentation technique
|
|
Les étapes ci-dessous décrivent des aspects importants de l'interface
La première fois que vous vous connecterez à l'API Manager, nous vous demanderons de remplir un formulaire pour nous fournir des informations incluant :
l'URL de votre site Web
le nom de votre site Web
le logo de votre site Web
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 à la Personal Profile 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).
Le URL de l'API
Les exemples de codes.
Les instructions d'utilisation relatives à tous ces éléments.
accédez à l' API Manager
pour commencer
Maintenant que vous avez lu la section « avant de commencer » et que l'API Manager vous est plus familière, vous êtes prêt à en savoir plus sur…
comment authentifier l’utilisateur
la méthode Personal RichProfile API en détail
les codes erreurs concernant Personal RichProfile API
Assurez-vous de bien connaître le procès Personal APIs privacy management.
Ce procès protège les utilisateurs Orange en évitant aux tierces parties d’accéder à leurs données personnelles sans leur permission.
comment authentifier l’utilisateur?
Premièrement, les utilisateurs doivent être authentifiés avant que l’accès à leurs données de profil soit autorisé.
L’authentification s’effectue avec l’Authentication API, qui renverra un jeton utilisateur.
Vous aurez ensuite besoin d’inclure le jeton utilisateur dans tous les appels de la Personal RichProfil API.
Ci-dessous un exemple de la manière dont l’appel est effectué :
Format:
[PersonalRichProfileV1URL]?action=[action name]&
token=[user token]¶m=[value]...
Exemple:
[PersonalRichProfileV1URL]?action=getPersonalRichProfile&
token=Hjlkzjlfkzef23423kjlkjr&infos=Gender,Firstname,Lastname,DateOfBirth,
PictureTagSmallURL,PreferredLanguage,HomeAddress,UserEMail,HomePhone,
UserType,CentersOfInterests,ProfileCreationDate,ProfileModificationDate
|
Si vous voulez savoir si votre code fonctionne, nous pouvons vous fournir un compte de test, ainsi vous pour que vous puissiez consulter les résultats comme si vous étiez un client Orange. Une fois votre inscription validée, nous vous montrerons comment en obtenir un.
la méthode Personal RichProfile API en détail
La Personal RichProfile API fournit une méthode :
getPersonalRichProfile
getPersonalRichProfile
Cette méthode récupère les données de profil d’un utilisateur Orange.
Pour appeler l’API, créez le format d’URL suivant dans votre application web et invoquez-le avec HTTP GET :
Format:
[PersonalRichProfileV1URL]?action= getPersonalRichProfile &
infos=[information]&token=[user token]
Exemple:
[PersonalRichProfileV1URL]?action= getPersonalRichProfile
&infos=Gender,DateOfBirth,Firstname,UserEMail,HomeAddress,
HomePhone,Lastname,PictureTagSmallURL&token=Hjlkzjlfkzef23423kjlkjr
|
paramètres d’entrée
| nom |
description |
obligatoire / optionnel |
type |
| infos |
comma separated attribute list:
Firstname,UserEMail,[…], UserType
|
obligatoire |
string |
| token |
user token that is retrieved using the Authentication API |
obligatoire |
string |
exemples de réponse
Réponse 1 : votre service nécessite le prénom, le nom et le type d’utilisateur d’un utilisateur Orange et ce dernier a autorisé l’accès à tous les attributs.
<?xml version="1.0" encoding="UTF-8"?>
<getPersonalRichProfileReturn>
<Data>
<UserAuthorizedData>
<Firstname>John</ Firstname>
<Lastname>Doe</ Lastname >
<UserType>M</UserType>
</UserAuthorizedData>
</Data>
</getPersonalRichProfileReturn>
|
Réponse 2 : votre service nécessite le prénom, le nom et le type d’utilisateur d’un utilisateur Orange, mais ce dernier ne vous donne pas accès au type d’utilisateur.
<?xml version="1.0" encoding="UTF-8"?>
<getPersonalRichProfileReturn>
<Data>
<UserAuthorizedData>
<Firstname>John</Firstname>
<Lastname>Doe</Lastname >
</UserAuthorizedData>
<UserProtectedData>
<UserType/>
</UserProtectedData>
<PrivacyDashboardURL>
[privacy interaction page]
</PrivacyDashboardURL>
</Data>
</getPersonalRichProfileReturn>
|
Dans ce cas, votre application devra utiliser seulement les attributs prénom et nom ou rediriger l’utilisateur Orange vers la page de gestion de protection de la vie privée, comme décrit dans le process Personal APIs privacy management process
description des réponses
| nom |
type |
commentaires |
Firstname |
String |
|
Lastname |
String |
|
DisplayName |
String |
|
UserEMail |
String |
|
Gender |
Integer |
1:Ms
2:Mrs
3:Mr |
DateOfBirth |
String |
YYYY-MM-DD (ISO 8601) |
NDIP |
Integer |
International format |
HomePhone |
Integer |
International format |
MobilePhone |
Integer |
International format |
HomeFax |
Integer |
International format |
OfficeFax |
Integer |
International format |
OfficeMobileNumber |
Integer |
International format |
OfficePhone |
Integer |
International format |
MobileDeviceTac |
Integer |
|
MobileDeviceModel |
String |
|
MobileDeviceBrand |
String |
|
PreferredLanguage |
String |
IETF RFC 3066 |
HomeAddress |
XML node |
<HomeAddress>
<Street1>
2 rue Nunc
</Street1>
<Street2/>
<ZipCode>
75014
</ZipCode>
<City>
Paris
</City>
<State/>
<Country>
FR
</Country>
</HomeAddress> |
OfficeAddress |
XML node |
<HomeAddress>
<Street1>
2 rue Nunc
</Street1>
<Street2/>
<ZipCode>
75014
</ZipCode>
<City>
Paris
</City>
<State/>
<Country>
FR
</Country>
</HomeAddress> |
ProfileModificationDate |
String |
YYYY-MM-DDThh:mm
(ISO 8601) |
ProfileCreationDate |
String |
YYYY-MM-DDThh:mm
(ISO 8601) |
UserType |
Integer |
0: NSRU
1: I
2: M
3: I+M
4: NDRTC |
PictureTagTinyURL |
String |
URL |
PictureTagSmallURL |
String |
URL |
PictureTagLargeURL |
String |
URL |
PictureTagMediumURL |
String |
URL |
CentersOfInterests |
Pipe-separated list of integers |
1: Livres/ musiques/ vidéos
2: Voyages/ tourisme
3: Informatique
4: Automobile
5: Famille
6: Bricolage/ jardinage
7: Maison/ décoration
8: Gastronomie
9: Bourse/ finance
10: Sports
11: Beauté/ santé
12: Jeux/ jeux vidéos
13: Immobilier
14: Mode
15: Caritatif
16: Emploi
17: People
18: Cinema |
(retour à la méthode getPersonalRichProfile)
codes erreurs pour Personal RichProfile API
Lorsqu’une erreur survient, la réponse correspond au format suivant :
<?xml version="1.0" encoding="UTF-8"?>
< getPersonalRichProfileReturn >
<error>
<code>[code value]</code>
<detail>[error detailed message]</detail>
</error>
</getPersonalRichProfileReturn > |
Le tableau ci-dessous présente les codes erreurs spécifiques à cette API.
Veuillez noter que les descriptions données ici sont d’un haut niveau. Si vous voulez détailler les descriptions d’erreurs pour certains codes, contactez-nous à l’adresse developers@orange.com
| Code |
Description |
102, 103 |
Error correlated to the user's account |
203, 204, 205, 501, 503, 504, 505, 900 |
Internal error |
(haut de page)
