- - Language
RavenWeb API - Rivenditore
- Invio SMS
- Backoffice

RavenWeb API - Rivenditore

Di seguito è riportato il formato dell'URL al quale i rivenditori dovranno fare riferimento per le modalità di invio descritte sopra. Le specifiche di invio restano invariate.
Per le specifiche complete di invio fare riferimento a RavenWeb API

URL di riferimento : http://gateway_host/raven/sms/send

Backoffice

URL di riferimento : http://gateway_host/raven/backoffice/manager

Parametri comuni ad ogni azione

login

Login dell'account rivenditore

password

Password dell'account rivenditore

action

Azione da impartire al backoffice

vh

web_virtualhost

Aggiungere un nuovo cliente

Azione di riferimento (parametro action) : customer-add

Esempio :

http://gateway_host/raven/backoffice/manager?action=customer-add&login=LOGIN&password=PASSWORD
                    &cust_login=loginCustomer&cust_password=passCustomer&vh=web_virtualhost

Parametri

cust_login

Login del nuovo cliente

cust_password

Password del nuovo cliente

timezone

Time Zone di riferimento del nuovo cliente.

Il time zone di default è Europe/Rome

netblock

IP address per autenticazione, uno o più indirizzi IP (o reti di indirizzi nel formato 0.0.0.0/0) separate da virgola.

currency

Moneta di riferimento del cliente.

Valori possibili : EUR, USD, GBP, CAD, AUD, CHF, HKD, JPY. Il valore di default è EUR

reseller

Se il rivenditore che accede al backoffice ha i permessi per creare ulteriori rivenditori potrà valorizzare questo parametro con uno dei seguenti valori :

0

L'account non sarà un account rivenditore ma un account cliente

1

L'account potrà creare ulteriori sotto-account ma non avrà i permessi per creare dei listini. (Opzione non abilitata in questa versione.)

2

L'account sarà un rivenditore di tipo Silver.

3

L'account sarà un rivenditore di tipo Gold

Risposta

Il gateway risponderà inoltrando una struttura XML di questo tipo :

Successo

 
        <?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>Messaggio</message></error>
         </xml>

Aggiungere i contatti di un nuovo cliente

Azione di riferimento (parametro action) : customer-add-contacts

Esempio :

http://gateway_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&vh=web_virtualhost

Parametri

user_id

Identificativo univoco del cliente creato precedentemente

name

Nome del cliente

surname

Cognome del cliente

company

Nome Azienda

email_tech

Contatto tenico del cliente

email_admin

Contatto amministrativo del cliente

mobile

Cellulare del cliente

Risposta

Successo

        <?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>Messaggio</message></error>
         </xml>

Aggiungere credito

Azione di riferimento (parametro action) : customer-add-credit

Esempio :

http://gateway_virtualhost/raven/backoffice/manager?action=customer-add-credit&login=LOGIN
           &password=PASSWORD&user_id=1111&pl_id=20&credit=100000&vh=web_virtualhost

Parametri

user_id

Identificativo univoco del cliente.

pl_id

Identificativo univoco della lista prezzi SMS. La lista prezzi deve essere stata precedentemente creata manualmente dal rivenditore attraverso l'interfaccia di gestione.

La lista prezzi conterrà il costo di ogni singolo messaggio per nazione di destinazione.

credit

Credito da aggiungere. Il valore del credito deve essere espresso in decimillesimi di euro.
Esempio : 10,00 Euro dovranno essere convertiti in 100000.

Risposta

Successo

  <?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>

Errore

  <?xml version="1.0" encoding="iso-8859-1"?>
  <xml>
        <error><code>NN<\/code><message>Messaggio</message></error>
  </xml>

Modifica password utente

Azione di riferimento (parametro action) : password-mod

Esempio :

http://gateway_virtualhost/raven/backoffice/manager?action=mod-password&login=LOGIN
          &password=PASSWORD&user_id=1111&cust_password=NUOVAPASS&vh=web_virtualhost

Parametri

user_id

Identificativo univoco del cliente.

cust_password

Nuova password da assegnare.

Nota : il sistema non effettuerà alcun controllo sul contenuto della password.

random

Valori possibili : 0 (disabilitato) 1 (abilitato). Abilitando la modalità random il sistema genererà automatica una password casuale di 8 caratteri.

Risposta

Successo

  <?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>NUOVAPASS</password>
        </object>
   </backoffice>
   </result></xml>

Errore

  <?xml version="1.0" encoding="iso-8859-1"?>
  <xml>
        <error><code>NN<\/code><message>Messaggio</message></error>
  </xml>

Abilitare e disabilitare un account

Azione di riferimento (parametro action) : customer-block

Esempio :

http://gateway_virtualhost/raven/backoffice/manager?action=customer-block&login=LOGIN&password=PASSWORD
                                &user_id=1111&enabled=0&vh=web_virtualhost

Parametri

user_id

Identificativo univoco del cliente.

enabled

Stato dell'account. Valori possibili : 0 (disabilitato) 1 (abilitato)
Settando il valore 0 l'account sarà disabilitato viceversa l'account sarà abilitato e avrà accesso alla piattaforma.

Risposta

Successo

        <?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>

Errore

         <?xml version="1.0" encoding="iso-8859-1"?>
         <xml>
               <error><code>NN<\/code><message>Messaggio</message></error>
         </xml>

Aggiungere un contatto in Rubrica

Azione di riferimento (parametro action) : add-abcontact

Esempio :

http://gateway_host/raven/backoffice/manager?action=add-abcontact&login=LOGINCLIENTE&password=PASSWORDCLIENTE
                    &vh=web_reseller_virtualhost&mode=text&name=NAME&surname=SURNAME&email=EMAILADDRESS&mobile=MOBILEPHONE
                    &fixed=FIXEDLINE&bdate=YYYY-MM-DD&gender=M

Parametri

name

Nome del contatto (opzionale)

surname

Cognome del nuovo contatto (opzionale)

email

Indirizzo E-Mail del nuovo contatto (opzionale)

mobile

Cellulare del nuovo contatto (opzionale)

fixed

Telefono fisso del nuovo contatto (opzionale)

bdate

Data di nascita del nuovo contatto (opzionale)

gender

Sesso del nuovo contatto (opzionale). Valori possibili: m o f

Risposte

Il gateway risponderà inoltrando una stringa testuale:

Successo

OK

Errore

ERROR [ERROR Code]

Negozio Online Rivenditore

Il sistema di rivendita permette di gestire un negozio online configurabile dal rivenditore attraverso la propria area di amministrazione. I suoi clienti avranno la possibilità di acquistare online e completare gli ordini scegliendo come metodo di pagamento tra:

Bonifico Bancario
Carta di Credito

Nel primo caso l'utente, al termine dell'acquisto, visualizzerà le coordinate bancarie che il rvenditore avrà precedentemente impostato nella sua area di configurazione.

Nel secondo caso l'utente, al termine dell'acquisto, sarà redirezionato verso il gateway di pagamento con carta di credito che il rivenditore avrà deciso di utilizzare.

Al termine dell'acquisto con carta di credito, la piattaforma di rivendita richiamerà l'URL del gateway di pagamento che il rivenditore avrà impostato nel pannello configurazione, saranno passati i seguenti parametri relativi all'ordine effettuato:

IMPORTO (Importo totale dell'acquisto)
NAME (Nome del cliente)
SURNAME (Cognome del cliente)
COMPANY (Nome Azienda se presente all'interno dell'anagrafica)
EMAILADMIN (email amministrativa del cliente)
SHOPID (Identificativo dell'ordine)

Attraverso questo sistema di rilancio sarà possibile integrare qualsiasi sistema di pagamento online.

Lista Errori

ERR 42 Error wrong user_id [not your customer]
ERR 43 Error while adding customer contacts
ERR 43 Error while adding credit