Langue

Italiano English Español Français Deutsch

RavenWeb API - Revendeur

Envoi de SMS

Vous trouverez ci-après le format de l'URL auquel les revendeurs devront se référer pour les modalités d'envoi décrites précédemment.

Les indications d'envoi ne changent pas.

Pour les indications complètes d'envoi, reportez-vous RavenWeb API fr

URL de référence : http://virtualhost/raven/sms/send

Backoffice

Paramètres communs à chaque action

  • nom utilisateur

Nom utilisateur du compte revendeur

  • password

Mot de passe du compte revendeur

  • action

Action à confier au backoffice

Ajouter un nouveau client

Action de référence (paramètre action) : client-ajouter

Exemple :

http://virtualhost/raven/backoffice/manager?action=customer-add&login=LOGIN&password=PASSWORD

                    &cust_login=loginCustomer&cust_password=passCustomer

Paramètres

  • client_nom utilisateur

Nom utilisateur du nouveau client

  • client_mot de passe

Mot de passe du nouveau client

  • fuseau horaire

Fuseau horaire de référence du nouveau client.

Le fuseau horaire par défaut est Europe/Rome

  • liste d'adresses

Adresse IP pour authentification, une ou plusieurs adresses IP (ou réseaux d'adresse au format 0.0.0.0/0) séparées par une virgule.

  • devise

Devise de référence du client.

Valeurs possibles : EUR, USD, GBP, CAD, AUD, CHF, HKD, JPY. La valeur par défaut est EUR

  • revendeur

Si le revendeur qui accède au backoffice a les droits lui permettant de créer d'autres revendeurs, il pourra renseigner ce paramètre avec l'une des valeurs suivantes :

  • 0

Le compte n'est pas un compte revendeur, mais un compte client

  • 1

Le compte pourra créer d'autres sous-comptes, mais ne pourra pas créer des listes. (Option non autorisée dans cette version.)

  • 2

Le compte sera un revendeur de type Silver

  • 3

Le compte sera un revendeur de type Gold

Réponse

La passerelle répondra par l'envoi d'une structure XML de ce type :

  • Succès
 

        <?xml version="1.0" encoding="iso-8859-1"?>

         <xml>

           <result>

            <backoffice>

               <object type="add-response">

                  <status>OK</status>

                  <user_id>1111</user_id>

               </object>

           </backoffice>

          </result>

         </xml>
  • Errore
         <?xml version="1.0" encoding="iso-8859-1"?>

         <xml>

               <error><code>NN<\/code><message>Message</message></error>

         </xml>

Ajouter les contacts d'un nouveau client

Action de référence (paramètre action) : client-ajouter-contacts

Exemple :

http://virtualhost/raven/backoffice/manager?action=customer-add-contacts&login=LOGIN&password=PASSWORD

               &user_id=1111&name=NOME&surname=COGNOME&email_tech=EMAILT&email_admin=EMAILA

Paramètres

  • utilisateur_id

Identifiant univoque du client créé précédemment

  • Prénom

Prénom du client

  • Nom

Nom du client

  • entreprise

Nom Entreprise

  • adresse électronique_tech

Contact technique du client

  • adresse électronique_admin

Contact administratif du client

  • portable

Numéro de portable du client

Réponse

  • Succès
        <?xml version="1.0" encoding="iso-8859-1"?>

         <xml><result>

           <backoffice>

               <object type="add-response">

                     <status>OK</status>

                    <user_id>1111</user_id>

               </object>

           </backoffice>

          </result></xml>
  • Erreur
         <?xml version="1.0" encoding="iso-8859-1"?>

         <xml>

               <error><code>NN<\/code><message>Message</message></error>

         </xml>

Ajouter du crédit

Action de référence (paramètre action) : client-ajouter-crédit

Exemple :

http://virtualhost/raven/backoffice/manager?action=customer-add-credit&login=LOGIN

           &password=PASSWORD&user_id=1111&pl_id=20&credit=100000

Paramètres

  • utilisateur_id

Identifiant univoque du client.

  • lt_id

Identifiant univoque de la liste tarifaire des SMS. La liste tarifaire doit avoir été préalablement créée manuellement par le revendeur grâce à l'interface de gestion.

La liste tarifaire indiquera le prix de chaque message par pays de destination.

  • crédit

Crédit à ajouter. La valeur du crédit devra être indiquée en dix millièmes d'euro.

Exemple : 10,00 euros doivent être convertis en 100000.

Réponse

  • Succès
  <?xml version="1.0" encoding="iso-8859-1"?>

  <xml><result>

   <backoffice>

        <object type="add-credit-response">

              <status>OK</status>

             <user_id>1111</user_id>

        </object>

   </backoffice>

   </result></xml>
  • Erreur
  <?xml version="1.0" encoding="iso-8859-1"?>

  <xml>

        <error><code>NN<\/code><message>Message</message></error>

  </xml>

Modification du mot de passe utilisateur

Action de référence (parametro action) : mot de passe-mod

Exemple :

http://virtualhost/raven/backoffice/manager?action=mod-password&login=LOGIN

          &password=PASSWORD&user_id=1111&cust_password=NUOVAPASS

Paramètres

  • utilisateur_id

Identifiant univoque du client.

  • client_mot de passe

Nouveau mot de passe à attribuer.

N.B : le système n'effectuera aucun contrôle sur le contenu du mot de passe.

  • aléatoire

Valeurs possibles : 0 (désactivé) 1 (activé). En activant la fonction aléatoire, le système génère automatiquement un mot de passe aléatoire de 8 caractères.

Réponse

  • Succès
  <?xml version="1.0" encoding="iso-8859-1"?>

  <xml><result>

   <backoffice>

        <object type="password-mod-response">

              <status>OK</status>

             <user_id>1111</user_id>

             <password>NOUVEAU MOT DE PASSE</password>

        </object>

   </backoffice>

   </result></xml>
  • Erreur
  <?xml version="1.0" encoding="iso-8859-1"?>

  <xml>

        <error><code>NN<\/code><message>Message</message></error>

  </xml>

Activer et désactiver un compte

Action de référence (paramètre action) : client-groupe

Exemple :

http://virtualhost/raven/backoffice/manager?action=customer-block&login=LOGIN&password=PASSWORD

                                &user_id=1111&enabled=0

Paramètres

  • utilisateur_id

Identifiant univoque du client.

  • activé

Statut du compte. Valeurs possibles : 0 (désactivé) 1 (activé)

En mettant la valeur 0, le compte sera désactivé et vice versa le compte sera activé et aura accès à la plateforme.

Réponse

  • Succès
        <?xml version="1.0" encoding="iso-8859-1"?>

         <xml><result>

           <backoffice>

               <object type="customer-block-response">

                     <status>OK</status>

                    <user_id>1111</user_id>

               </object>

           </backoffice>

          </result></xml>
  • Erreur
         <?xml version="1.0" encoding="iso-8859-1"?>

         <xml>

               <error><code>NN<\/code><message>Message</message></error>

         </xml>

Liste Erreurs

ERR 42 Erreur utilisateur_id erronné [pas votre client]

ERR 43 Erreur dans la tentative d'accès aux contacts client

ERR 43 Erreur dans la tentative d'ajout de crédit

ravenweb_api_rivenditore_fr.txt · Last modified: 2012/02/14 16:40 (external edit)
 
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki