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 Calendar API.
|
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 Calendar 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 (PersonalCalendarV1URL).
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
ajouter un événement « Hello World »
les méthodes de la Personal Calendar API en détail
les codes d'erreur de la Personal Calendar API
comment authentifier l'utilisateur
Premièrement, les utilisateurs doivent être authentifiés avant que l'accès à leur calendrier 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 la Personal Calendar API.
Ci-dessous, un exemple sur la manière dont l'appel est effectué :
|
Format:
[PersonalCalendarV1URL]?action=[action name]&token=[user token]¶m=[value]...
Example:
[PersonalCalendarV1URL]?action=addevent&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.
ajouter un événement "Hello World" event
Ajouter un événement « Hello World » au calendrier 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 la Calendar API.
Pour plus d'informations, consultez la section comment authentifier l'utilisateur.
Vous pourrez ensuite appeler la requête suivante (en ajoutant un événement
« Hello World ») :
|
[PersonalCalendarV1EndPoint]?action=addevent&title=Hello%20World&
location=&description=&startdate=21/06/2008&starttime=20:00&
enddate=21/06/2008&endtime=21:00&datepattern=dd/MM/yyyy&
timepattern=HH:mm&token=Hjlkzjlfkzef23423kjlkjr |
Le code ci-dessus ajoutera l'événement au calendrier de l'utilisateur Orange. Facile.
les méthodes de la Personal Calendar API en détail
La Personal Calendar API offre quatre méthodes :
addevent
addeventoffline
geteventlist (bientôt disponible)
checkavailability (bientôt disponible)
addevent
Ajouter un événement au calendrier d'un 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:
[PersonalCalendarV1EndPoint]?action=addevent&title=[title]&
location=[location]&description=[description]&startdate=[start date]&
starttime=[start time]&enddate=[end date]&endtime=[end time]&
datepattern=dd/MM/yyyy&timepattern=HH:mm&token=[user token]
Exemple:
[PersonalCalendarV1EndPoint]?action=addevent&title=test&
location=some%20location&description=some%20description&
startdate=10/01/2000&starttime=10:00&enddate=10/01/2000&
endtime=11:00&datepattern=dd/MM/yyyy&timepattern=HH:mm&
token=Hjlkzjlfkzef23423kjlkjr |
paramètres d'entrée
| Name |
Description |
Obligatoire |
Type |
| title |
the title of the event |
Oui |
String |
| startdate |
start date of event |
Oui |
Date |
| enddate |
end date of event |
Oui |
Date |
| starttime |
start time of event |
Oui |
Time |
| endtime |
end time of event |
Oui |
Time |
| datepattern |
date format, value = dd/MM/yyyy |
Oui |
String |
| timepattern |
time format, value = HH:mm |
Oui |
String |
| description |
description of the event |
Oui |
String |
| location |
location of the event |
Oui |
String |
| token |
user token that is retrieved using the Authentication API |
Oui |
String |
exemple de réponse
Si l'événement est correctement ajouté, la réponse contiendra l'ID de l'événement ainsi qu'un résultat = 0 et se présentera comme suit :
|
<?xml version="1.0" encoding="UTF-8" ?>
<xpage version="1.0">
<command-list>
<command action="cauupdate" request="s01">
<event-data>
<eventid>4790</eventid>
<id>10012000</id>
</event-data>
<result>0</result>
</command>
</command-list>
<parameter-list />
</xpage> |
(retour aux méthodes de l'API en détail)
addeventoffline
Ajouter un événement au calendrier d'un client Orange France comme l'opération addevent mais avec une durée de jeton plus importante pour avoir la possibilité d'ajouter un événement même si le client final n'est plus connecté (avec un jeton généré auparavant).
Pour appeler l'API, créez l'URL selon le format suivant dans votre application Web et invoquez-le via HTTP GET :
Format:
[PersonalCalendarV1EndPoint]?action=addeventoffline&title=[title]&
location=[location]&description=[description]&startdate=[start date]&
starttime=[start time]&enddate=[end date]&endtime=[end time]&
datepattern=dd/MM/yyyy&timepattern=HH:mm&token=[user token]
Exemple:
[PersonalCalendarV1EndPoint]?action=addeventoffline&title=test&
location=some%20location&description=some%20description&
startdate=10/01/2000&starttime=10:00&enddate=10/01/2000&
endtime=11:00&datepattern=dd/MM/yyyy&timepattern=HH:mm&
token=Hjlkzjlfkzef23423kjlkjr |
Les paramètres d'entrée, l'exemple de réponse et les codes d'erreur sont les mêmes que la méthode addevent.
(retour aux méthodes de l'API en détail)
les codes d'erreur de la Personal Calendar API
Lorsqu'une erreur se produit, la réponse contient un code d'erreur (paramètre de « type »), un sous-type interne et le message :
|
<command request="" action="action">
<result>-yyy</result>
<error subtype="xxx" type="yyy">message</error>
</command> |
Ci-dessous, un tableau décrivant les erreurs les plus significatives :
| Code d'erreur |
Message |
| 1 |
'mandatory parameter' is missing. |
| 2 |
'parameter' is invalid. |
| 4 |
The command 'action' is unknown. |
| 5 |
'end-userid' is incorrect (database is corrupted). |
| 100 |
Service Calendar not provisioned for this end-user. |
(haut de page)
