icon_qa

INTRODUZIONE API REST

Usi l'app Postman?
 

ALIAS (MITTENTI SMS)

Lista Alias

Ritorna la lista degli alias configurati.

Gli alias sono i mittenti alfanumerici utilizzabili per l'invio SMS.

URI

GET https://api.smshosting.it/rest/api/alias/list

Richiesta

Nessun dato richiesto

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
401 Credenziali non valide
405 Metodo HTTP non consentito
500 Errore generico

Dati Alias

ProprietàDescrizione
id Identificativo dell'Alias
alias stringa identificativa dell'alias
vatnumber partiva iva
taxcode codice fiscale
businessname ragione sociale
address indirizzo
city comune
postcode CAP
province provincia
country Nazione
email email
phone telefono
status

Stato dell'Alias.

I possibili stati sono:

VERIFIED - alias verificato e utilizzabile nell'invio

NOTVERIFIED - alias non utilizzabile nell'invio poichè non verificato

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET https://api.smshosting.it/rest/api/alias/list
[
  {
    "id": 13497,
"alias": "test",
"vatnumber": "01019390259",
"taxcode": "01019390259",
"businessname": "smshosting.it",
"address": "via masi simonetti 48",
"city": "belluno",
"postcode": "32100",
"province": "BL",
"country": "IT",
"email": "info@smshosting.it",
"phone": "043700000",
"status": "VERIFIED" } ]

Nuovo Alias

Crea un nuovo Alias

URI

POST https://api.smshosting.it/rest/api/alias

Richiesta

  Il "Content-Type" per le richieste POST deve essere "application/x-www-form-urlencoded"
ParametroObbligatorioTipoDescrizione
alias Si String

Stringa identificativa dell'alias.

La stringa non può superare gli 11 caratteri.

Può contenere solo lettere (a-z) maiuscole o minuscole, numeri, spazi ed i caratteri . _ - & @ * ''

businessname Si String

ragione sociale dell'azienda da associare all'alias

address Si String indirizzo della sede dell'azienda da associare all'alias
city Si String

comune della sede dell'azienda da associare all'alias

postcode Si String CAP della sede dell'azienda da associare all'alias
province Si String provincia della sede dell'azienda da associare all'alias
country Si String

nazione della sede dell'azienda da associare all'alias.

Specificare il codice ISO 3166-1 a due lettere.

Ad esempio per l'italia specificare IT

vatnumber Si String partita IVA dell'azienda da associare all'alias
email Si String email dell'azienda da associare all'alias
phone Si String telefono dell'azienda da associare all'alias
taxcode Si String codice fiscale dell'azienda da associare all'alias

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
400

Parametri non validi

I possibili errorMsg sono:

BAD_ALIAS - Alias assente o non valido

BAD_BUSINESSNAME - paramatro businessname non valido

BAD_VATNUMBER - paramatro vatnumber non valido

BAD_ADDRESS - paramatro address non valido

BAD_CITY - paramatro city non valido

BAD_POSTCODE - parametro postcode non valido

BAD_PROVINCE - parametro province non valido

BAD_COUNTRY- parametro country non valido

BAD_EMAIL - parametro email non valido

BAD_PHONE - parametro phone non valido

BAD_TAXCODE - parametro taxcode non valido

GENERIC_ERROR - errore interno al server

401 Credenziali non valide
405 Metodo HTTP non consentito
500 Errore generico

Dati Alias

In caso di successo verranno restituiti i dati dell'Alias appena creato

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET -XPOST https://api.smshosting.it/rest/api/alias \
-d "alias=test" \
-d "vatnumber=01019390259" \
-d "taxcode=01019390259" \
-d "businessname=smshosting.it" \
-d "address=via masi simonetti 48" \
-d "city=belluno" \
-d "postcode=32100" \
-d "province=BL" \
-d "businessname=info@smshosting.it" \
-d "email=IT" \
-d "phone=043700000"
{
   "id": 13497,
"alias": "test",
"vatnumber": "01019390259",
"taxcode": "01019390259",
"businessname": "smshosting.it",
"address": "via masi simonetti 48",
"city": "belluno",
"postcode": "32100",
"province": "BL",
"country": "IT",
"email": "info@smshosting.it",
"phone": "043700000",
"status": "VERIFIED" }

Cancella Alias

Cancella in modo definitivo un Alias.

URI

DELETE https://api.smshosting.it/rest/api/alias/<id>

Richiesta

Nessun parametro richiesto

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
400

Parametri non validi

I possibili errorMsg sono:

ALIAS_NOT_EXISTS - Alias non trovato

401 Credenziali non valide
405 Metodo HTTP non consentito
500 Errore generico

 

 Esempio:

curl --user AUTH_KEY:AUTH_SECRET -XDELETE https://api.smshosting.it/rest/api/alias/13497