 |
|
 |
|
La Personal Messages API alpha fait partie de la suite Personal APIs.
Elle permet aux clients Orange France d'accéder depuis votre site Web aux informations relatives aux messages reçus (e-mail, SMS et MMS).
L'API alpha est actuellement limitée au service emails. Toutefois, les services de SMS et de MMS seront bientôt disponibles.
Elle permet aux clients de consulter :
 le nombre total d'e-mails reçus le nombre d'e-mails non lus
L'accès à la liste des contacts ne peut se faire qu'après avoir informé le client et obtenu son consentement. Ceci s'applique aux utilisateurs inscrits sur www.orange.fr
Une fois l'utilisateur authentifié par Orange via l'Authentication API, les informations peuvent être recherchées et extraites.
Utilisez cette API pour développer des services personnalisés informant vos utilisateurs Orange de l'arrivée de leurs messages.
|
|
 |
|
 |
L'API est actuellement en alpha mode et fait partie de la suite alpha Personal APIs.
Cela signifie que vous pouvez l'utiliser GRATUITEMENT mais qu'il existe quelques restrictions de service (comme vous devez vous y attendre).
Cela signifie aussi qu'elle est dans les premiers stades de développement. Nous avons besoin de vos avis !
N'hésitez pas, utilisez l'API alpha et dites nous ce que vous en pensez.
 qu'est-ce que c'est et quelles sont ses fonctionnalités ?
avant de démarrer
comment authentifier l'utilisateur
les méthodes de l'Personal Messages API en détail
les codes d'erreur de l'Personal Messages API
|
dites-nous ce que vous en pensez
partagez vos idées
obtenez de l'aide
envoyez-nous un e-mail
autres Personal APIs
Authentication API
Personal Calendar API
Personal Contacts API
Personal Photos API
Personal Profile API |
qu'est-ce que c'est et quelles sont ses fonctionnalités ?
En un mot, (actuellement) l'Personal Messages API vous permet :
de rechercher et d'extraire le nombre total d'e-mails de la messagerie Orange.
de rechercher et d'extraire le nombre d'e-mails non lus de la messagerie Orange.
Ci-dessous, quelques illustrations de la manière dont l'API peut être intégrée à un site Web ou à une application de type widget :
(exemple de l'API intégrée à un site Web)
(exemple de l'API intégrée à un widget PC)
(exemple de l'API intégrée à un widget PC)
(haut de page)
avant de démarrer
Pour commencer à tester cette API, assurez-vous d'avoir lu et compris la section Personal APIs (alpha)
Vous remarquerez qu'il est nécessaire de suivre les étapes suivantes :
étape 1 - devenir membre d'Orange Partner
étape 2 - accéder à l'administrator web interface
Ensuite, une fois dans l'administrator web interface, vous pourrez vous inscrire à l' Personal Messages 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 (PersonalMessagesV1URL).
Des exemples de codes.
Les instructions d'utilisation relatives à tous ces éléments.
en savoir plus sur l'administrator web interface
(haut de page)
comment authentifier l'utilisateur
Premièrement, les utilisateurs doivent être authentifiés avant que l'accès à 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 l' Personal Messages API.
Ci-dessous, un exemple de la manière dont l'appel est effectué :
|
Format:
[PersonalMessagesV1URL]?action=[action name]&token=[user token]¶m=[value]...
Example:
[PersonalMessagesV1URL]?action=getPNS&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.
(haut de page)
les méthodes de l'Personal Messages API en détail
L'API Personal Messages offre une méthode :
getPNS (rechercher et extraire les informations relatives au message)
getPNS (rechercher et extraire les informations relatives au message)
Cette méthode recherche et extrait le nombre d'e-mails et le nombre d'e-mails non lus 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:
[PersonalMessagesV1URL]?action=getPNS&infos=[information]&token=[user token]
Example:
[PersonalMessagesV1URL]?action=getPNS&infos=NoUnReadMails,NoMails&token=Hjlkzjlfkzef23423kjlkjr |
paramètres d'entrée
| Nom |
Description |
Obligatoire |
Type |
| infos |
Liste d'attributs séparés par une virgule :
NoUnReadMails,NoMails |
Oui |
String |
| token |
« user token » récupéré grâce à l'Authentication API |
Oui |
String |
exemple de réponse
|
<?xml version="1.0" encoding="UTF-8"?>
<getPNSReturn>
<Process>
<Status>OK</Status>
<ElapseTime>0.0094530582428</ElapseTime>
</Process>
<Data>
<SyndicationData>
<NoUnReadMails>3</NoUnReadMails>
<Extension>
<NoEMails>18</NoEMails>
</Extension>
</SyndicationData>
</Data>
</getPNSReturn> |
description des codes de réponse
| Nom |
Type |
Description |
| NoUnReadMails |
int |
Nombre d'e-mails non lus dans la boîte e-mail Orange de l'utilisateur authentifié |
| NoEMails |
int |
Nombre d'e-mails dans la boîte e-mail Orange de l'utilisateur authentifié |
(haut de page)
les codes d'erreur de l'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"?>
<getPNSReturn>
<Process><Status>Error</Status>
<Logs>
<Log><Code>203</Code>
<Message>A mandatory parameter is missing</Message>
<Severity>High</Severity>
</Log>
</Logs>
<ElapseTime>1193297722.65</ElapseTime>
</Process>
</getPNSReturn> |
Ci-dessous, un tableau décrivant les codes d'erreur
| Code |
Statut |
Description |
| 103 |
PNS_UNKNOWN_ISE |
l'utilisateur n'a pas été trouvé. vérifiez votre jeton d'utilisateur (user token) |
| 203 |
PNS_MISSING_PARAMETER |
Paramètre obligatoire manquant |
| 501 |
PNS_UNAUTHORIZED_SERVICE_ERROR |
un champ non prévu a été utilisé. Vérifiez vos paramètres |
| 502 |
PNS_UNKNOWN_FIELD_ERROR |
champ inconnu |
(haut de page)
