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 :
- récupérer l'URL de l'API concernée
- concaténer le verbe associé au service de l'API (une même API peut avoir différents verbes)
- 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▲