Provider SMS

FoxIDs supporta l'invio di messaggi SMS con Access URL, Gateway API, Smstools e Telia SMS Gateway. Il provider SMS può essere configurato come provider SMS in ogni ambiente o globalmente nella configurazione del sito FoxIDs.

FoxIDs invia messaggi SMS agli utenti per codici di verifica, accesso senza password e autenticazione multi-fattore quando SMS è abilitato nel flusso di login.

FoxIDs include provider SMS standard per API di provider supportate e un provider SMS Access URL generico per provider non integrati. Usa i provider standard quando l'API del provider corrisponde a una delle integrazioni supportate. Usa Access URL quando il provider può ricevere una richiesta HTTPS GET con parametri di query specifici del provider.

Access URL

Il provider Access URL è un provider generico per integrazioni SMS flessibili. Chiama un endpoint HTTPS specifico del provider con i parametri di query richiesti dal provider SMS concreto. L'API URL è una URL base HTTPS assoluta senza parametri di query. I parametri di query sono configurati separatamente e possono usare valori fissi o placeholder.

Placeholder supportati:

• {phone} - il numero di telefono dell'utente.
• {message} - il testo del messaggio SMS.
• {fromName} - il nome mittente SMS configurato.

Esempio di configurazione Access URL:

• API URL: https://some-provider.dk/sms/
• username = xxxxxx
• password = yyyyyy
• recipient = {phone}
• from = zzzzzz o {fromName}
• message = {message}

FoxIDs invia la richiesta come HTTP GET e codifica in URL ogni valore di parametro di query. L'API URL viene registrata insieme al numero di telefono. I parametri di query non vengono registrati. Se il provider restituisce un errore, FoxIDs registra il numero di telefono, il messaggio SMS, il codice di stato HTTP e la risposta del provider.

Configurare il provider SMS nell'ambiente

Il provider SMS può essere configurato in ogni ambiente, dove il nome mittente è obbligatorio. Se un provider SMS è configurato nell'ambiente, viene usato al posto di qualsiasi provider SMS configurato globalmente.

Access URL

Configura Access URL con una API URL e i parametri di query richiesti dal provider SMS. L'API URL deve essere una URL base HTTPS assoluta senza parametri di query. Aggiungi ogni parametro di query separatamente e usa placeholder dove il valore deve essere inserito al momento dell'invio.

Valori obbligatori:

• Type: AccessUrl
• Nome mittente
• API URL
• Parametri di query con almeno un placeholder {phone} e un placeholder {message}

Gateway API

Configura Gateway API con l'endpoint del provider e il token. Il nome mittente viene inviato come mittente SMS e l'etichetta opzionale viene inviata a Gateway API.

Valori obbligatori:

• Type: GatewayApi
• Nome mittente
• API URL
• Client secret

Valori opzionali:

• Label

Smstools

Configura Smstools con l'endpoint del provider, client ID e client secret. Il nome mittente viene inviato come mittente SMS.

Valori obbligatori:

• Type: Smstools
• Nome mittente
• API URL
• Client ID
• Client secret

Telia SMS Gateway

Configura Telia SMS Gateway con l'endpoint del provider, sender address, API key e certificato mTLS. Il nome mittente viene inviato come nome mittente SMS e il client ID viene inviato come sender address.

Valori obbligatori:

• Type: TeliaSmsGateway
• Nome mittente
• API URL
• Client ID (sender address)
• Client secret (API key)
• Certificato mTLS

Configurare il provider SMS globalmente

Il provider SMS può essere configurato opzionalmente globalmente nelle application settings del sito FoxIDs. Il nome mittente è obbligatorio.

L'API URL deve essere una URL HTTPS assoluta per tutti i provider SMS. Per Access URL, l'API URL deve essere anche una URL base senza parametri di query e i parametri di query devono includere almeno un placeholder {phone} e un placeholder {message}.

Access URL

Configurare Access URL con application settings:

"Settings": {
  "Sms": {
    "Type": "AccessUrl",
    "FromName": "My-sender",
    "ApiUrl": "https://some-provider.dk/sms/",
    "Parameters": [
      {
        "Name": "username",
        "Value": "xxxxxx"
      },
      {
        "Name": "password",
        "Value": "yyyyyy"
      },
      {
        "Name": "recipient",
        "Value": "{phone}"
      },
      {
        "Name": "from",
        "Value": "{fromName}"
      },
      {
        "Name": "message",
        "Value": "{message}"
      }
    ]
  }
}

Configura i parametri di query Access URL in Parameters. Ogni parametro ha un Name e un Value. I parametri di query devono includere almeno un placeholder {phone} e un placeholder {message}. I placeholder {phone}, {message} e {fromName} possono essere usati nei valori dei parametri.

Gateway API

Configurare Gateway API con application settings:

"Settings": {
  "Sms": {
    "Type": "GatewayApi",
    "FromName": "My-sender",
    "ApiUrl": "https://gatewayapi.eu/rest/mtsms",
    "ClientSecret": "gateway-api-token",
    "Label": "FoxIDs"
  }
}

ClientSecret viene inviato come token Gateway API. Label è opzionale.

Smstools

Configurare Smstools con application settings:

"Settings": {
  "Sms": {
    "Type": "Smstools",
    "FromName": "My-sender",
    "ApiUrl": "https://app.smstools.com",
    "ClientId": "client-id",
    "ClientSecret": "client-secret"
  }
}

Telia SMS Gateway

Configurare Telia SMS Gateway con application settings:

"Settings": {
  "Sms": {
    "Type": "TeliaSmsGateway",
    "FromName": "My-sender",
    "ApiUrl": "https://smsgw.teliamobile.dk:12123/messaging/v1/outbound/12345/requests",
    "ClientId": "12345",
    "ClientSecret": "b7dc08b6-54c8-46c2-ba37-21855d0acca4",
    "CertificatePemCrt": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
    "CertificatePemKey": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----"
  }
}

ClientId viene inviato come sender address. ClientSecret viene inviato come API key. Il certificato e la chiave privata sono usati per mTLS.

Documentazione correlata

• Provider email
• Autenticazione a due fattori e multi-fattore
• Login & HRD
• Deployment