Présentation des API Web Service Orange : monde du mobile / monde de la voix

Orange API

Les API Orange offre un cadre simple pour ajouter de multiples fonctionnalités à toute application, dans le monde mobile avec l'envoi de SMS, de MMS, la géo localisation ; ainsi que dans le monde de la voix avec la création d'appels, de conférences et la gestion de messages vocaux.

- Titre : Présentation des API Web Service Orange : monde du mobile / monde de la voix

- Auteur : Orange API

- Parution : 7 juin 2010

- Mise à jour : 9 juin 2010

- Licence : Les sources présentées sur cette page sont libres de droits et vous pouvez les utiliser à votre convenance. Par contre, la page de présentation constitue une œuvre intellectuelle protégée par les droits d'auteur. Copyright ® 2010 Developpez LLC. Tous droits réservés Developpez LLC. Aucune reproduction, même partielle, ne peut être faite de ce site et de l'ensemble de son contenu : textes, documents et images sans l'autorisation expresse de Developpez LLC. Sinon vous encourez selon la loi jusqu'à trois ans de prison et jusqu'à 300 000 € de dommages et intérêts.

Sommaire

- I. Introduction

- II. Fonctionnement général de toute API Orange

- II-A. point d'entrée : la clé d'identification

- II-B. en requête GET

- II-C. en requête POST

- III. Envoi et réception de SMS / MMS

- III-A. L'API SMS

- III-B. L'API MMS

- IV. Localisation d'un mobile

- IV-A. Demander une autorisation

- IV-B. Localiser le mobile

- IV-C. Exemple de code PHP

- V. Création d'appels et conférences téléphoniques

- V-A. Création d'appels (click-2-call)

- V-B. Conférences téléphoniques (click-2-conf)

- VI. Gestion de messages vocaux

- VI-A. Requête GET

- VI-B. Exemple de fichier VoiceXML

- VII. Récupération de l'historique des appels aux API

- VII-A. Requête GET

- VII-B. Exemple de code PHP

- VIII. Cas d'usage : La M-Shoutbox de l'API SMS

- IX. Conclusion

I - Introduction

Pour faciliter l'accès à leurs services, de nombreuses entreprises ont créé des Web Services librement accessibles sur le Web. L'API (on utilisera indifféremment dans la suite le terme de Web Service et d'API) cartographique de Google (déjà présentée sur le club des développeurs) est l'une des plus connues. Le site www.programmableweb.com recense pas moins de 2000 API (chiffre à la date du 01/06/2010).
Cet article se propose de vous présenter les API d'Orange à travers quelques exemples.
Les API d'Orange sont des interfaces de programmation qui permettent d'ajouter de nombreuses fonctionnalités de communication à toute application : des sites web ou des applications métiers.
Elles couvrent actuellement
- le monde mobile :

- envoi et réception de SMS vers les mobiles du monde entier, quelque soit l'opérateur

- envoi et réception de MMS vers les mobiles Orange

- géo localisation de mobiles Orange

- le monde voix :

- création d'appels vers les téléphones fixes et mobiles (solution « click-to-call »)

- conférences téléphoniques à plusieurs (solution « click-to-conf »)

- services vocaux (solution « voicemashup »)

Animation en format "flash" non supportée.
Contenu uniquement consultable en ligne à cette adresse :
https://flash.developpez.com/faq/fichiers/interpolation_mouvement.swf

(cliquez ici pour aggrandir l'image)

II - Fonctionnement général de toute API Orange

II-A - point d'entrée : la clé d'identification

Avant toute chose, l'utilisateur devra s'enregistrer sur le site d'Orange API pour obtenir sa clé d'accès au service. Il pourra aussi configurer différents paramètres des API, comme des mots clés spécifiques pour les SMS, par exemple. Une même clé est valable pour toutes les API et il n'y a pas de restriction sur le type d'usage (commercial, privé...). Certaines API en mode alpha sont gratuites avec une limitation de volume seulement, d'autres sont payantes. Dans ce cas, il est nécessaire de créditer son compte.
Comme la clé d'identification est envoyée à chaque accès à un web service, il est important de ne jamais la diffuser, et donc de bien la masquer dans le code.

II-B - en requête GET

La plupart des accès aux API peut se faire par requête HTTP GET, et fonctionne toujours de la même manière. Il suffit de :

1. récupérer l'URL de l'API concernée

2. concaténer le verbe associé au service de l'API (une même API peut avoir différents verbes)

3. ajouter les paramètres requis (certains sont obligatoires, d'autres non)

Exemple pour l'envoi d'un SMS :

URL

http://sms.beta.orange-api.net/sms/

Verbe

sendSMS.xml

Paramètres

id

clé d'identification obtenue sur le site d'Orange API

from

numéro court d'émission, ex : 38100 pour France multi opérateurs

to

numéro de téléphone du destinataire du SMS

content

message du SMS à envoyer

http://sms.beta.orange-api.net/sms/sendSMS.xml?id=[clé d'identification]&from=[numéro court d'émission]&to=[numéro de téléphone]&content=[message à envoyer]

II-C - en requête POST

III - Envoi et réception de SMS / MMS

III-A - L'API SMS

III-B - L'API MMS

IV - Localisation d'un mobile

IV-A - Demander une autorisation

IV-B - Localiser le mobile

IV-C - Exemple de code PHP

V - Création d'appels et conférences téléphoniques

V-A - Création d'appels (click-2-call)

V-B - Conférences téléphoniques (click-2-conf)

VI - Gestion de messages vocaux

VI-A - Requête GET

VI-B - Exemple de fichier VoiceXML

VII - Récupération de l'historique des appels aux API

VII-A - Requête GET

VII-B - Exemple de code PHP

VIII - Cas d'usage : La M-Shoutbox de l'API SMS

IX - Conclusion

Retour à l'article