Dans les exemples de cette documentation l'on utilise le symbole {:name} pour votre nom d'utilisateur et {:pass} pour votre mot de passe.

Transcription

1 Action API Aspects généraux Lleida.net dispose de notifications basées sur des événements L'Action API permet d'accéder aux services de configuration de notifications de Lleida.net à travers de requêtes HTTP (nos vous recommandons l'utilisation du protocole HTTPS). L'URL de l'api est: La manière la plus simple d'authentification est d'utiliser votre nom d'utilisateur dans le paramètre user et votre mot de passe dans le paramètre password. Dans les exemples de cette documentation l'on utilise le symbole {:name} pour votre nom d'utilisateur et {:pass} pour votre mot de passe. Toutes les opérations exigent les paramètres suivants: user Nom d'utilisateur du compte de Lleida.net. password Le mot de passe d'utilisateur request Type de requête. request_id Optionnel. Identifiant de la requête Nous en recommandons l'utilisation malgré le fait d'être optionnel. Les paramètres d'entrée peuvent être encapsulés dans un document XL ou JSON. Ce document doit continuer en format défini en action.dtd ( Requêtes en format XML GET HTTP/1.1 xml={:action_xml} Content-type: application/x-www-form-urlencoded

2 Requêtes en format JSON GET HTTP/1.1 Accept: application/json json={:action_json} Content-type: application/x-www-form-urlencoded Accept: application/json Requêtes avec des variables Une autre alternative est d'envoyer les paramètres comme tuples clé: valeur La réponse peut être configurée en format XML ou JSON. GET HTTP/1.1 Accept: application/json user={:name}&password={:pass}&... Content-type: application/x-www-form-urlencoded Allons-y!! Format de réponse Toutes les opérations reçoivent comme réponse un autre document XML ou JSON dont le nœud principal est l'élément response. Cet élément se compose de plusieurs éléments (toujours présents) communs à toutes les opérations, suivis d'autres éléments spécifiques pour l'opération demandée. Les éléments communs de l'élément response sont les suivants: code Est le code d'état informatif du succès ou de l'échec de l'opération. status Est la description du code d'état. request Contient un nom identificateur de l'opération appelée. Les réponses respectent la spécification de la DTD action_response.dtd (

3 Codes d'état Status Description 200 Success 1400 Method not allowed 1401 Invalid request 1402 Invalid content 1404 Invalid XML 1405 Invalid JSON 1500 Unknown error 1501 Timeout error 1502 Connection error 1503 Service unavailable Status Description Événements et Actions Événements Les événements sont regroupés par MO (Mobile Originated), par DR (Delivery Report), par PDF (Génération de certificats) et ALERT. Ces événements sont les responsables de lancer la notification configurée par l'utilisateur. Actions ALERT Notification de numéro disponible. MO_SMS Réception d'un SMS. DR_SMS Mise à jour de l'état d'un accusé de réception d'un SMS. MO_MMS Réception d'un MMS. DR_MMS Mise à jour de l'état d'un accusé de réception d'un MMS. PDF_SMS Finalisation de la génération du PDF certifié d'un SMS envoyé ou reçu. PDF_MMS Finalisation de la génération du PDF certifié d'un MMS envoyé ou reçu. Il existe de nombreuses actions disponibles pour configurer les notifications. Chaque action n'a qu'un seul paramètre obligatoire. L'action MAIL_CERT est la seule action avec le paramètre optionnel lang dont la valeur par défaut est Español - ES. CGI A comme paramètre une URL. MAIL A comme paramètre une adresse de courrier électronique. MAIL_CERT A comme paramètre une adresse de courrier électronique valide et, optionnellement, la langue du certificat.

4 RESP_AUTO_MMS A comme paramètre le nom d'un objet multimédia. RESP_AUTO_SMS A comme paramètre le texte qui sera envoyé par SMS. REDIRECT A comme paramètre un numéro de téléphone. MULTIMEDIA_OBJECT A comme paramètre le nom de l'objet multimédia. Paramètres des actions url Doit commencer par http(s):// Adresse de courrier électronique valide lang Langue du certificat text Texte du SMS d'un maximum de 160 caractères (un seul SMS). name_obj Nom de l'objet multimédia number Numéro où le SMS sera renvoyé. La grille suivante montre le rapport entre les actions et les événements; et le type de paramètre qui peut être configuré. ALERT MO_SMS DR_SMS MO_MMS DR_MMS PDF_SMS PDF_MMS CGI url url url url url url url MAIL MAIL_CERT lang lang MULTIMEDIA_OBJECT text text REDIRECT number RESP_AUTO_MMS name_obj name_obj RESP_AUTO_SMS text text ALERT MO_SMS DR_SMS MO_MMS DR_MMS PDF_SMS PDF_MMS Langues valides pour les certificats

5 Code AR CA DE EN ES EU FR GL IT JA Code Langue Español (Argentina) Catalá Deutsch English Espagnol Euskara Français Galego Italiano 日 本 語 (Japanese) Langue Champs de l'action CGI Détail des champs envoyés par POST en fonction de l'événement configuré. ALERT MO_SMS MO_MMS idalert destination état date_état rcode mcc mnc id_user date origine destination texte idmo data_coding esm_class udh date origine

6 DR_SMS DR_MMS PDF_SMS PDF_MMS destination idmms idaccuse état date_reception idsms date_envoi origine destination texte idaccuse état date_reception idmms date_envoi origine destination cert_type lang event mo mt mt_id src dst ref_tsa cert_type lang event mmso mmst mmst_id src dst ref_tsa Ajouter notification GET HTTP/1.1

7 Paramètres user Nom d'utilisateur du compte de Lleida.net. password Votre mot de passe d'utilisateur request add_action. request_id Optionnel. Identifiant de la requête Nous en recommandons l'utilisation malgré le fait d'être optionnel. number Numéro de téléphone ou all. action Type de notification. CGI A comme paramètre une URL. MAIL A comme paramètre une adresse de courrier électronique. MAIL_CERT A comme paramètre une adresse de courrier électronique valide et, optionnellement, la langue du certificat. RESP_AUTO_MMS A comme paramètre le nom d'un objet multimédia. RESP_AUTO_SMS A comme paramètre le texte qui sera envoyé par SMS. REDIRECT A comme paramètre un numéro de téléphone. MULTIMEDIA_OBJECT A comme paramètre le nom de l'objet multimédia. event Type d'événement ALERT Notification de numéro disponible. MO_SMS Réception d'un SMS. DR_SMS Mise à jour de l'état d'un accusé de réception d'un SMS. MO_MMS Réception d'un MMS. DR_MMS Mise à jour de l'état d'un accusé de réception d'un MMS. PDF_SMS Finalisation de la génération du PDF certifié d'un SMS envoyé ou reçu. PDF_MMS Finalisation de la génération du PDF certifié d'un MMS envoyé ou reçu. value Est l'url ou texte ou ou numéro de l'action. Exemple de requête user={:name}&password={:pass}&request=add_action&number=all&action=cgi& event=mo_sms&value= Content-type: application/x-www-form-urlencoded Réponse <?xml version="1.0" encoding="iso "?> <!DOCTYPE response SYSTEM "action_response.dtd"> <response> <request>add_action</request> <code>200</code> <status>success</status> <user> <id>391967</id> <name>{:name}</name> <credit>48.00</credit>

8 <numbers> <number> </number> <number> </number> <number> </number> <number> </number> <number> </number> </numbers> <actions> <total>2</total> <action> <id>25122</id> <event>mo_sms</event> <type>mail</type> <number>all</number> </action> <action> <id>25123</id> <event>mo_sms</event> <type>cgi</type> <value> <number>all</number> </action> </actions> </user> </response> Éditer notification GET HTTP/1.1 Paramètres user Nom d'utilisateur du compte de Lleida.net. password Votre mot de passe d'utilisateur request edit_action. request_id Optionnel. Identifiant de la requête Nous en recommandons l'utilisation malgré le fait d'être optionnel. action_id Identifier la notification. value Est l'url ou texte ou de l'action. Exemple de requête user={:name}&password={:pass}&request=edit_action&action_id=25123& value=

9 Content-type: application/x-www-form-urlencoded Réponse <?xml version="1.0" encoding="iso "?> <!DOCTYPE response SYSTEM "action_response.dtd"> <response> <request>edit_action</request> <code>200</code> <status>success</status> <user> <id>391967</id> <name>{:name}</name> <credit>48.00</credit> <numbers> <number> </number> <number> </number> <number> </number> <number> </number> <number> </number> </numbers> <actions> <total>2</total> <action> <id>25122</id> <event>mo_sms</event> <type>mail</type> <number>all</number> </action> <action> <id>25123</id> <event>mo_sms</event> <type>cgi</type> <value> <number>all</number> </action> </actions> </user> </response> Supprimer notification

10 GET HTTP/1.1 Paramètres user Nom d'utilisateur du compte de Lleida.net. password Votre mot de passe d'utilisateur request delete_action. request_id Optionnel. Identifiant de la requête Nous en recommandons l'utilisation malgré le fait d'être optionnel. action_id Identifier la notification. Exemple de requête user={:name}&password={:pass}&request=delete_action&action_id=25123 Content-type: application/x-www-form-urlencoded Réponse <?xml version="1.0" encoding="iso "?> <!DOCTYPE response SYSTEM "action_response.dtd"> <response> <request>delete_action</request> <code>200</code> <status>success</status> <user> <id>391967</id> <name>{:name}</name> <credit>48.00</credit> <numbers> <number> </number> <number> </number> <number> </number> <number> </number> <number> </number> </numbers> <actions> <total>1</total> <action> <id>25122</id> <event>mo_sms</event> <type>mail</type> <number>all</number> </action>

11 </actions> </user> </response> Consulter notifications GET HTTP/1.1 Paramètres user Nom d'utilisateur du compte de Lleida.net. password Votre mot de passe d'utilisateur request info. request_id Optionnel. Identifiant de la requête Nous en recommandons l'utilisation malgré le fait d'être optionnel. Exemple de requête user={:name}&password={:pass}&request=info Content-type: application/x-www-form-urlencoded Réponse <?xml version="1.0" encoding="iso "?> <!DOCTYPE response SYSTEM "action_response.dtd"> <response> <request>info</request> <code>200</code> <status>success</status> <user> <id>391967</id> <name>z</name> <credit>48.00</credit> <numbers> <number> </number> <number> </number> <number> </number> <number> </number> <number> </number> </numbers> <actions>

12 <total>1</total> <action> <id>25122</id> <event>mo_sms</event> <type>mail</type> <number>all</number> </action> </actions> </user> </response>