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 Messages.
|
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 à la Personal Messages API.
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
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
les méthodes de la Personal Messages API en détail
les codes d'erreur de la Personal Messages API
comment authentifier l'utilisateur
Premièrement, les utilisateurs doivent être authentifiés avant que l'accès aux informations relatives à leurs messages soit accordé.
L'authentification est effectuée via l'Authentication API qui renverra un jeton d'utilisateur (user token).
Vous inclurez ensuite ce jeton dans tous les appels de la Personal Messages API.
Ci-dessous, un exemple de la manière dont l'appel est effectué :
|
Format:
[PersonalMessagesV2URL]?action=[action name]&
token=[user token]¶m=[value]...
Example:
[PersonalMessagesV2URL]?action=getPersonalMessages&
token=Hjlkzjlfkzef23423kjlkjr¶m=value...
|
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.
les méthodes de la Personal Messages API en détail
L'API Personal Messages offre une méthode:
NOUVEAU! Dans sa dernière version en date, l'API Personal Messages permet d'extraire de nouvelles informations, à savoir le nombre de web SMS non lus et un aperçu des derniers e-mails non lus.
getPersonalMessages (rechercher et extraire les informations relatives aux messages)
getPersonalMessages (rechercher et extraire les informations relatives au message)
Cette méthode recherche et extrait le nombre de web SMS, le nombre d'e-mails, le nombre d'e-mails non lus et un aperçu des derniers e-mails de la boîte e-mail Orange d'un utilisateur.
Pour appeler l'API, créez l'URL selon le format suivant dans votre application Web et invoquez-le via HTTP GET:
|
Format:
[PersonalMessagesV2URL]?action=getPersonalMessages&
infos=[information]&token=[user token]
Example:
[PersonalMessagesV2URL]?action=getPersonalMessages&
infos=NoEMails,NoUnReadMails,NoSMS,EmailsLastNDetailed&
token=Hjlkzjlfkzef23423kjlkjr |
paramètres d'entrée
| Nom |
Description |
Obligatoire |
Type |
| infos |
comma separated attribute list:
NoEMails, NoUnReadMails, NoSMS, EmailsLastNDetailed |
Oui |
String |
| token |
user token that is retrieved using the
Authentication API |
Oui |
String |
exemple de réponse
|
<?xml version="1.0" encoding="UTF-8"?>
<getPersonalMessagesReturn>
<Data>
<UserAuthorizedData>
<NoUnReadMails>0</NoUnReadMails>
</UserAuthorizedData>
<UserProtectedData>
<EmailsLastNDetailed/>
</UserProtectedData>
<PrivacyDashboardURL>http://a.b.c/def</PrivacyDashboardURL>
</Data>
</getPersonalMessagesReturn>
|
description des champs
| Nom |
Type |
Description |
| NoEmails |
int |
Nombre d'e-mails dans la boîte e-mail Orange de l'utilisateur authentifié |
| NoUnReadMails |
int |
Nombre d'e-mails non lus dans la boîte e-mail Orange de l'utilisateur authentifié |
| NoSMS |
int |
Nombre de web SMS non lus |
| EmailsLastNDetailed |
xml (*) |
"Aperçu" des derniers emails non lus dans la boîte e-mail Orange de l'utilisateur authentifié |
Exemple:
|
<EmailsLastNDetailed>
<msgs>
<msg>
<msg_id>10</msg_id>
<msg_from>0320202024<noreply@wanadoo.fr></msg_from>
<msg_date>Sun, 7 Mar 2006 15:35:06 +0100 (CET)
</msg_date>
<msg_subject>Demande d'informations</msg_subject>
<msg_begin_body>Bonjour, peux-tu me transmettre comme promis ta recette de crumb
</msg_begin_body>
<msg_url_access>http:// webmail.wanadoo.fr/webmail/fr_FR/read_syn.html?idm=10&idb=xxx
</msg_url_access>
</msg>
<msg>
<msg_id>11</msg_id>
<msg_from>jdupont@wanadoo.fr</msg_from>
<msg_date>Sun, 7 Mar 2006 16:12:52 +0100 (CET)
</msg_date>
<msg_subject>De retour de mes vacances</msg_subject>
<msg_begin_body>Bonjour cher ami, comment se porte la famil
</msg_begin_body>
<msg_url_access>http:// webmail.wanadoo.fr/webmail/fr_FR/read_syn.html?idm=11&idb=xxx
</msg_url_access>
</msg>
</msgs>
</EmailsLastNDetailed>
|
les codes d'erreur de la Personal Messages API
Lorsqu'une erreur se produit, la réponse se présente dans le format suivant:
|
<?xml version="1.0" encoding="UTF-8"?>
<getPersonalMessagesReturn>
<error>
<code>103</code>
<detail>Error encountered. Please contact api support team with the error code number</detail>
</error>
</getPersonalMessagesReturn>
|
Ci-dessous, un tableau listant les codes d'erreur spécifiques à l'API (NB : la description est donnée à titre indicatif; merci de systématiquement contacter l'équipe support pour une analyse détaillée)
| Code |
Description |
| 102, 103 |
Erreur liée au compte utilisateur |
| 203, 204, 501, 503, 504, 505, 900 |
Erreur interne |
(haut de page)
