Skip to main content

Introduzione

Introduzione​

Gli indirizzi da utilizzare sono:

Autenticazione​

Parametri​

Questi parametri vanno accodati ad ogni richiesta

Nome variabileHeaderNote
api_tokenX-Api-TokenToken di autorizzazione. (** vedi note)
username(solo se richiesto dal token utilizzato) Username utilizzata per l'accesso su v2.smsviainternet.it
password(solo se richiesto dal token utilizzato) Password utilizzata per l'accesso su v2.smsviainternet.it
** api_token

In base alle impostazioni settate nel pannello di controllo è necessario, o meno, inserire anche username e password.

Entra nell'area riservata per ottenere chiave di autorizzazione.

danger

E' consigliabile impostare il token come Header X-Api-Token

Per retrocompatibilità può essere una variabile get o (solo per POST/PUT/DELETE) inviato nel corpo del messaggio, esempio: {"api_token": "xxxxx", ...altreVariabili}

Per capire/impostare se un api token richiede o meno username e password, è sufficiente andare nella sezione Accesso API nella propria area privata di v2.smsviainternet.it. Vedi Immagine 1.

Immagine 1:

Rivenditore​

info

I rivenditori possono usare accesso come subaccount impostando username del subaccount e chiave del rivenditore. In caso in cui non sia abilitato login obbligatorio per la chiave api, è obbligatorio fornire anche la password del subaccount.

Esempi di utilizzo api con accesso​

  • Api token (rivenditore): T.oK3n-reseller
  • Api token (subaccount): T.oK3n-subaccount
  • Account rivenditore: username= rivenditore password= 12345
  • Account subaccount: username= subaccount password= 54321
note

Hli utenti standard (inclusi i subaccount) accedono nello stesso modo in cui accede un rivenditore.

Inviare come rivenditore (o utente standard/subaccount): (api token non richiede login)

curl --location 'https://rivenditore.web-servizi.net/api/rest/v1/sms-batch.json' \
--header 'X-Api-Token: T.oK3n-reseller' \
--header 'Content-Type: application/json' \
--data '{
    "gateway": 0,
    "sender": "Agenzia",
    "text_template": "Ciao {{fullName}}, come stai? Il tuo codice è {{code}}",
    "default_placeholders": {},
    "async": true,
    "max_sms_length": 1,
    "utf8_enabled": false,
    "destinations": [
        {
            "number": "+393801234567",
            "placeholders": {
                "fullName": "Mario Rossi",
                "code": "1901"
            }
        }
    ]
}'
note

Nel corpo della richiesta SONO OMESSI username e password

Inviare come rivenditore (o utente standard/subaccount): (api token richiede login)

curl --location 'https://rivenditore.web-servizi.net/api/rest/v1/sms-batch.json' \
--header 'X-Api-Token: T.oK3n-reseller' \
--header 'Content-Type: application/json' \
--data '{
    "username": "rivenditore",
    "password": "12345",
    "gateway": 0,
    "sender": "Agenzia",
    "text_template": "Ciao {{fullName}}, come stai? Il tuo codice è {{code}}",
    "default_placeholders": {},
    "async": true,
    "max_sms_length": 1,
    "utf8_enabled": false,
    "destinations": [
        {
            "number": "+393801234567",
            "placeholders": {
                "fullName": "Mario Rossi",
                "code": "1901"
            }
        }
    ]
}'

Inviare come subaccount da account rivenditore: (api token non richiede login)

curl --location 'https://rivenditore.web-servizi.net/api/rest/v1/sms-batch.json' \
--header 'X-Api-Token: T.oK3n-reseller' \
--header 'Content-Type: application/json' \
--data '{
    "username": "subaccount",
    "gateway": 0,
    "sender": "Agenzia",
    "text_template": "Ciao {{fullName}}, come stai? Il tuo codice è {{code}}",
    "default_placeholders": {},
    "async": true,
    "max_sms_length": 1,
    "utf8_enabled": false,
    "destinations": [
        {
            "number": "+393801234567",
            "placeholders": {
                "fullName": "Mario Rossi",
                "code": "1901"
            }
        }
    ]
}'
note

Nel corpo della richiesta VIENE OMESSO password mentre viene impostato username

info

In questa chiamata il rivenditore rivenditore invia un sms come se fosse il subaccount subaccount.

Inviare come subaccount da account rivenditore: (api token richiede login)

curl --location 'https://rivenditore.web-servizi.net/api/rest/v1/sms-batch.json' \
--header 'X-Api-Token: T.oK3n-reseller' \
--header 'Content-Type: application/json' \
--data '{
    "username": "subaccount",
    "password": "54321",
    "gateway": 0,
    "sender": "Agenzia",
    "text_template": "Ciao {{fullName}}, come stai? Il tuo codice è {{code}}",
    "default_placeholders": {},
    "async": true,
    "max_sms_length": 1,
    "utf8_enabled": false,
    "destinations": [
        {
            "number": "+393801234567",
            "placeholders": {
                "fullName": "Mario Rossi",
                "code": "1901"
            }
        }
    ]
}'
note

Nel corpo della richiesta vengono passati username e password del subaccount appartenente al rivenditore reseller

info

In questa chiamata il rivenditore rivenditore invia un sms come se fosse il subaccount subaccount.

Il subaccount subaccount invia con il proprio account: (api token non richiede login)

curl --location 'https://rivenditore.web-servizi.net/api/rest/v1/sms-batch.json' \
--header 'X-Api-Token: T.oK3n-subaccount' \
--header 'Content-Type: application/json' \
--data '{
    "gateway": 0,
    "sender": "Agenzia",
    "text_template": "Ciao {{fullName}}, come stai? Il tuo codice è {{code}}",
    "default_placeholders": {},
    "async": true,
    "max_sms_length": 1,
    "utf8_enabled": false,
    "destinations": [
        {
            "number": "+393801234567",
            "placeholders": {
                "fullName": "Mario Rossi",
                "code": "1901"
            }
        }
    ]
}'
info

In questa chiamata il subaccount subaccount invia un sms usando il proprio account (Vedi il token api).

Test​

Per testare invio usare il gateway 99