Coupon Digitali


I Coupon Digitali sono una funzionalità del Piano Premium. Se utilizzi il piano Starter attiva gratis il tuo periodo di prova del Piano Premium.

Lista Campagne Coupon

Restituisce la lista delle Campagne Coupon dell'utente.

URI

GET https://api.smshosting.it/rest/api/digitalcoupon/campaign/list


Richiesta

ParametroObbligatorioTipoDescrizione
Nessun parametro

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
400

I possibili errorMsg sono:

PLAN_NOT_ENABLED - Questa chiamata non è permessa nel piano utente

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

 Esempio:

   curl --user AUTH_KEY:AUTH_SECRET \
   -XGET https://api.smshosting.it/rest/api/digitalcoupon/campaign/list
{
    "metadata": {
        "count": 2,
        "offset": 0,
        "limit": 0
    },
    "couponCampaignList": [
        {
            "id": 76,
            "name": "Secondo Coupon",
            "type": "D"
        },
        {
            "id": 38,
            "name": "Primo coupon",
            "type": "F"
        }
    ]
}

Dettaglio Campagna Coupon

Ritorna il dettaglio di una Campagna Coupon.

URI

GET https://api.smshosting.it/rest/api/digitalcoupon/campaign/{campaignId}


Richiesta

ParametroObbligatorioTipoDescrizione
Nessun parametro

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
401 Credenziali non valide
404 Campagna Coupon non trovata
405 Metodo HTTP non consentito
500 Errore generico

 Esempio:

   curl --user AUTH_KEY:AUTH_SECRET \
   -XGET https://api.smshosting.it/rest/api/digitalcoupon/campaign/38
{
    "id": 38,
    "name": "Primo Coupon",
    "type": "D",
    "insertDate": "2020-06-18T12:50:39+0200",
    "startDate": "2020-06-17T00:00:00+0200",
    "endDate": "2020-10-20T00:00:00+0200"
}

Nuova Campagna Coupon

Crea una nuova Campagna Coupon.

URI

POST https://api.smshosting.it/rest/api/digitalcoupon/campaign


Richiesta

  Il "Content-Type" per le richieste POST deve essere "multipart/form-data"
ParametroObbligatorioTipoDescrizione
title Si String

Nome della Campagna Coupon (es. `Black Friday 2020 Coupon`)

couponType Si String

[F|D] Coupon Fisso o Dinamico

couponCode No Integer

Codice del Coupon se di tipo Fisso (es. `2020BLACKF`)

startDate No String

Data di inizio validità della Campagna Coupon nel formato yyyy-MM-dd'T'HH:mm:ssZ

endDate No String

Data di fine validità della Campagna Coupon nel formato yyyy-MM-dd'T'HH:mm:ssZ

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
400

Parametri non validi, i possibili valori sono:

BAD_NAME - Manca il nome della campagna o è più lungo di 100 caratteri

MISSING_TYPE - Manca il tipo di campagna [F|D]

BAD_TYPE - Tipo campagna errato [F|D]

BAD_CODE - Codice campagna (di tipo F) nel formato errato: deve essere compreso fra 6 e 32 caratteri.

MISSING_START_DATE - Manca la data di inizio validità della Campagna Coupon

MISSING_END_DATE - Manca la data di fine validità della Campagna Coupon

BAD_DATE - Data nel formato errato

DUPLICATE_CODE - Codice campagna (di tipo F) duplicato

PLAN_NOT_ENABLED - Questa chiamata non è permessa nel piano utente

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

 Esempio:

   curl --user AUTH_KEY:AUTH_SECRET \
   -XPOST https://api.smshosting.it/rest/api/digitalcoupon/campaign \
   -d 'title=Black Friday 2020 Coupon' \
   -d 'couponType=D'
{
    "id": 38,
    "name": "Black Friday 2020 Coupon",
    "type": "D",
    "insertDate": "2020-06-30T10:17:47+0200"
}

Cerca Coupon

Cerca un coupon.

URI

GET https://api.smshosting.it/rest/api/digitalcoupon/coupon/search


Richiesta

ParametroObbligatorioTipoDescrizione
Nessun parametro

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
400

I possibili errorMsg sono:

PLAN_NOT_ENABLED - Questa chiamata non è permessa nel piano utente

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

 Esempio:

   curl --user AUTH_KEY:AUTH_SECRET \
   -XGET https://api.smshosting.it/rest/api/digitalcoupon/coupon/search?limit=2&campaignId=38
{
    "metadata": {
        "count": 11,
        "offset": 0,
        "limit": 2
    },
    "couponList": [
        {
            "code": "vwtthwrh",
            "insertDate": "2020-06-30T08:54:33+0200",
            "campaignId": 38
        },
        {
            "code": "1NBNFME8PR",
            "insertDate": "2020-06-29T14:31:14+0200",
            "campaignId": 38
        }
    ]
}

Dettaglio Coupon

Restituisce il dettaglio di un Coupon

URI

GET https://api.smshosting.it/rest/api/digitalcoupon/coupon/{couponCode}


Richiesta

ParametroObbligatorioTipoDescrizione
Nessun parametro

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
400

I possibili errorMsg sono:

PLAN_NOT_ENABLED - Questa chiamata non è permessa nel piano utente

401 Credenziali non valide
404 Coupon non trovato
405 Metodo HTTP non consentito
500 Errore generico

 Esempio:

   curl --user AUTH_KEY:AUTH_SECRET \
   -XGET https://api.smshosting.it/rest/api/digitalcoupon/coupon/MYCOUPON123
{
    "code": "MYCOUPON123",
    "insertDate": "2020-06-30T10:35:17+0200",
    "campaignId": 38,
    "usages": 5
}

Genera Coupon

Genera un nuovo Coupon.

URI

POST https://api.smshosting.it/rest/api/digitalcoupon/coupon


Richiesta

  Il "Content-Type" per le richieste POST deve essere "multipart/form-data"
ParametroObbligatorioTipoDescrizione
title Si String

Nome della Campagna Coupon (es. `Black Friday 2020 Coupon`)

campaignId Si Integer

id della campagna coupon a cui aggiungere il coupon

couponCode No String

Codice del Coupon se di tipo Dinamico (compreso tra 6 e 32 caratteri). Se non fornito viene generato un Codice Coupon casuale che viene fornito nella risposta

couponLength No Integer

Lughezza del Codice Coupon casuale generato automaticamente

Default: 6

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
400

Parametri non validi, i possibili valori sono:

BAD_CAMPAIGN - La Campagna Coupon non esiste o il codice è errato.

BAD_TYPE - Tipo Campagna Coupon non è Dinamico

BAD_CODE - Codice Coupon di lunghezza errata o contiene caratteri non validi

DUPLICATE_CODE - Codice Coupon duplicato

PLAN_NOT_ENABLED - Questa chiamata non è permessa nel piano utente

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

 Esempio:

   curl --user AUTH_KEY:AUTH_SECRET \
   -XPOST https://api.smshosting.it/rest/api/digitalcoupon/campaign \
   -d 'campaignId=38'
{
    "code": "0K3YRU",
    "insertDate": "2020-06-30T11:50:42+0200",
    "campaignId": 38
}

Segna Utilizzo Coupon

Segna un Coupon come utilizzato, se il copon è Dinamico si può utilizzare una sola volta

URI

POST https://api.smshosting.it/rest/api/digitalcoupon/coupon/{couponId}/usage


Richiesta

  Il "Content-Type" per le richieste POST deve essere "multipart/form-data"
ParametroObbligatorioTipoDescrizione
Nessun parametro

Risposta

HTTP Status Code

CodiceDescrizione
200 ok
400

Parametri non validi, i possibili valori sono:

BAD_CODE - Codice Coupon di lunghezza errata o contiene caratteri non validi

ALREADY_USED - Codice Coupon di tipo Dinamico già utilizzato

PLAN_NOT_ENABLED - Questa chiamata non è permessa nel piano utente

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

 Esempio:

   curl --user AUTH_KEY:AUTH_SECRET \
   -XPOST https://api.smshosting.it/rest/api/digitalcoupon/coupon/MYCOUPON_2020/usage
{
    "code": "MYCOUPON_2020",
    "insertDate": "2020-06-29T12:51:53+0200",
    "campaignId": 38,
    "usages": 10
}