Italiano
Live Chat

Metodi API Unisender

  • getLists - ottieni tutte le mailing lists con codici
  • subscribe - aggiungi sottoscrittore a una o più mailing lists
  • sendSms - invia singolo messaggio SMS
  • checkSms - controlla lo stato di invio degli SMS

Descrizione Generale

API è disponibile gratuitamente per tutti i conti. Di default non è attivo e devi entrare nel tuo account e abilitarlo. La chiave API è disponibile anche ne tuo account. La chiave è confidenziale ed è proibito distribuirla altrimenti chiunque potrà accedere al tuo conto e ai tuoi dati personali e dei tuoi sottoscrittori.

API può funzionare sia in modalità test che live. Nella modalità test tutte le azioni che potrebbero modificare dati in realtà non lo fanno. Raccomandiamo di usare questa modalità per il debugging. Successivamente potete switchare alla modalità live.

Metodo Chiamata

Per chiamare il metodo API devi fare una richiesta HTTP come segue: 

http://api.unisender.com/en/api/METHOD?format=json&api_key=KEY&arg1=ARG_1&argN=ARG_N
dove:

METHOD
Nome metodo
KEY
Chiave API
ARG_1 ... ARG_N
parametri

Tutti i parametri devono essere codificati UTF-8. Nell'esempio sopra usiamo la richiesta GET, ma anche POST è disponibile. Inoltre, POST e più affidabile perchè non lascia i dati della chiave API nei log dei proxy server e firewell.

Il risultato è nel formato JSON.

Successo nel Metodo Chiamata

Se la chiamata va a buon fine, il risultato conterrà un campo "result", il cui contenuto dipende dal metodo.

In alcuni casi un campo "warning" può essere aggiunto al valore risultato.

Un esempio di valore di ritorno da una chiamata andata a buon fine: 

{
  "result":523514,
  "warnings":[
    {"warning":"probably not a mobile phone"}
  ]
}

Errore nel Metodo Chiamata

Se il valore ottenuto contiene il campo "error", significa che la chiamata non è riuscita. Il campo contiene messaggio HTML-encoded che descrive l'errore e potrebbe contenere anche il codice dell'errore. Il campo "Result" deve essere ignorato.

Codici errore standard::

unspecified
No error code is provided. Read a message for details.
invalid_api_key
Incorrect API key is provided. Please check if api_key matched the value provided in your account.
access_denied
Access denied. Please check if API is enabled in your account and you do not attempt to call the method which is not available for you.
unknown_method
Incorrect method name
not_enough_money
Not enough money on your account for performing the action

Questi codici errore sono standard per tutti i metodi API.

Un esempio di valore su metodo chiamata non riuscita: 

{"error":"AK100310-02","code":"invalid_api_key"}