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 à l'API Personal Favourites.
|
sur l'API Manager
L'API Manager 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 à l'API Personal Favourites.
Une fois votre inscription validée, nous vous enverrons un e-mail et un fichier ZIP contenant :
Votre clé d'accès (SERVICE_ID et SERVICE_PWD).
L'URL de l'API (PersonalFavouritesV1URL).
Des 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
ajouter un favori « Hello World »
les méthodes de l'API Personal Favourites en détail
les codes d'erreur de l'API Personal Favourites
comment authentifier l'utilisateur
Premièrement, les utilisateurs doivent être authentifiés avant que l'accès à leurs favoris soit accordé.
L'authentification est effectuée via l'Authentication API qui renverra un jeton d'utilisateur.
Vous inclurez ensuite le jeton dans tous les appels de l'API Personal Favourites.
Ci-dessous, un exemple sur la manière dont l'appel est effectué :
|
Format:
[PersonalFavouritesV1URL]?action=[action name]&
token=[user token]¶m=[value]...
Example:
[PersonalFavouritesV1URL]?action=addBookmark&
token=Hjlkzjlfkzef23423kjlkjr¶m=value...
NB : cet exemple met l'accent sur la manière de passer le jeton utilisateur dans les requêtes PersonalFavourites. Pour le détail fonctionnel de l'API (détails des paramètres d'entrée et leurs valeurs possibles), voir ci-dessous.
|
Si vous souhaitez savoir si votre code a fonctionné, nous pouvons vous fournir un compte de test 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.
ajouter un favori "Hello World"
Ajouter un favori « Hello World » aux favoris d'un client Orange est facile.
Premièrement, récupérez un jeton d'utilisateur en utilisant l'Authentication API. Ce jeton d'utilisateur sera utilisé comme paramètre « jeton » lors de l'appel de l'API Personal Favourites.
Pour plus d'informations, consultez la section comment authentifier l'utilisateur.
Vous pourrez ensuite appeler la requête suivante (en ajoutant un favori
« Hello World ») :
|
[PersonalFavouritesV1URL]?action=addBookmark&token=Hjlkzjlfkzef23423kjlkjr&
title=Hello%20World&description=this%20is%20an%20example&
url=http%3A//favoris.orange.fr &tags=test,PersonalFavorites,orange |
Le code ci-dessus ajoutera le favori au calendrier de l'utilisateur Orange. Facile.
les méthodes de l'API Personal Favourites en détail
L'API Personal Favourites offre une méthode :
addBookmark
addBookmark
Ajouter un favori au service "Orange Favoris" du client Orange France.
Pour appeler l'API, créez l'URL selon le format suivant dans votre application Web et invoquez-le via HTTP GET :
|
Format:
[PersonalFavouritesV1URL]?action=addBookmark&token=[jeton_utilisateur]&
title=[titre_favori]&description=[description_favori]&tags=[tags_favori]
Example:
[PersonalFavouritesV1URL]?action=addBookmark&token=Hjlkzjlfkzef23423kjlkjr&
title=Hello%20World&description=this%20is%20an%20example&
url=http%3A//favoris.orange.fr &tags=test,PersonalFavorites,orange
|
paramètres d'entrée
| Nom |
Description |
Obligatoire |
Type |
| token |
jeton utilisateur récupéré via l'API d'Authentification |
Oui |
String |
| title |
titre du favori |
Oui |
String |
| description |
description du favori |
Non |
String |
| url |
URL du favori |
Oui |
String |
| tags |
liste de tags, séparés par une virgule. 8 tags au maximum |
Non |
String |
exemple de réponse
Si le favori est correctement ajouté, la réponse retournera simplement un code 0 et se présentera comme suit :
|
<?xml version="1.0"?>
<addBookmarkResponse>
<code>0</code>
</addBookmarkResponse>
|
les codes d'erreur de l'API Personal Favourites
Lorsqu'une erreur se produit, une réponse est retournée au client au format HTTP, code 500. Le corps de la réponse contient un flux XML qui détaille l'erreur :
|
<?xml version="1.0"?>
<addBookmarkResponse>
<error>
<code> [code d'erreur] </code>
<detail> [message d'erreur] </detail>
</error>
</addBookmarkResponse> |
Ci-dessous, un tableau décrivant les erreurs les plus significatives :
| Code d'erreur |
Message |
| 1 |
Title not set |
| 2 |
URL not valid |
| 3 |
URL already exists |
| 5 |
Tags list cannot exceed 8 tags |
| 6 |
User unknown. The Orange user should activate first their "Mes Favoris" service at [FavouritesPortalURL]. (*) |
(*) Actuellement, le service n'est pas activé implicitement. Le client.doit rediriger l'utilisateur Orange vers [FavouritesPortalURL] afin d'activer explicitement le service.
(haut de page)
