Con TIM Open puoi partecipare alla community degli sviluppatori, pubblicare le tue soluzioni su TIM Digital Store, utilizzare e rivendere i servizi di TIM.

Guarda anche

Panoramica

Introduzione

La Authentication OTP API consente di inviare via SMS una One Time Password (OTP) ad utente mobile e successivamente di verificare la OTP ricevuta. La OTP API può essere utilizzata dalle applicazioni esterne per finalità di autenticazione utente.

Sicurezza

Autenticazione

L’API Authentication OTP descritta in questo documento adotterà il meccanismo di autenticazione che si basa su un API-Key. L’API-Key sarà fornita nel parametro KeyId dell’header http della richiesta.

Otp

La risorsa One-Time-Password esposta tramite questa API

Otp

Invia
POST/otp/v1.1/{phoneNumber}

Invia via SMS una One-Time-Password (OTP) al numero indicato.

Example URI

POST /otp/v1.1/3427706442
URI Parameters
HideShow
phoneNumber
string (required) Example: 3427706442
Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "result": {
    "status": "OK",
    "description": "Richiesta Otp inserita nella coda di invio."
  }
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi:

  • Sottoscrizione non attiva.

  • Frequenza traffico richieste superata.

  • Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json
Response  502
HideShow

Il server ha ricevuto una risposta non valida dal server a cui ha eseguito l’accesso per soddisfare la richiesta.

Headers
Content-Type: application/json

Otp

Verifica
GET/otp/v1.1{?phoneNumber,password}

Consente di verificare la Otp inviata.

Example URI

GET /otp/v1.1?phoneNumber=3427706442&password=1666177
URI Parameters
HideShow
phoneNumber
string (required) Example: 3427706442
password
string (required) Example: 1666177
Request
HideShow
Headers
Content-Type: application/json
KeyId: d93decd9-b053-47ba-be26-d1da62942ff1
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "result": {
    "status": "OK",
    "description": "Esito verifica positivo"
  }
}
Response  400
HideShow

La richiesta non è stata formulata in maniera corretta.

Headers
Content-Type: text/plain
Response  404
HideShow

Risorsa non trovata

Headers
Content-Type: text/plain
Response  403
HideShow

Errore di autenticazione

Headers
Content-Type: text/plain
Response  412
HideShow

Le condizioni per effettuare la richiesta non sono soddisfatte, in particolare l’invocazione dell’API non è permessa per uno dei seguenti motivi:

  • Sottoscrizione non attiva.

  • Frequenza traffico richieste superata.

  • Soglia richieste superata.

Headers
Content-Type: application/json
Response  500
HideShow

Errore generico del server

Headers
Content-Type: application/json
Response  502
HideShow

Il server ha ricevuto una risposta non valida dal server a cui ha eseguito l’accesso per soddisfare la richiesta.

Headers
Content-Type: application/json