Dostawca SMS

FoxIDs obsługuje wysyłanie wiadomości SMS za pomocą Access URL, Gateway API, Smstools i Telia SMS Gateway. Dostawcę SMS można skonfigurować jako dostawcę SMS w każdym środowisku lub globalnie w konfiguracji witryny FoxIDs.

FoxIDs wysyła wiadomości SMS do użytkowników dla kodów weryfikacyjnych, logowania bez hasła i uwierzytelniania wieloskładnikowego, gdy SMS jest włączony w przepływie logowania.

FoxIDs zawiera standardowych dostawców SMS dla obsługiwanych API dostawców oraz ogólnego dostawcę SMS Access URL dla dostawców, którzy nie są wbudowani. Użyj standardowych dostawców, gdy API dostawcy pasuje do jednej z obsługiwanych integracji. Użyj Access URL, gdy dostawca może odebrać żądanie HTTPS GET z parametrami zapytania specyficznymi dla dostawcy.

Access URL

Dostawca Access URL jest ogólnym dostawcą dla elastycznych integracji SMS. Wywołuje specyficzny dla dostawcy endpoint HTTPS z parametrami zapytania wymaganymi przez konkretnego dostawcę SMS. API URL jest bezwzględnym HTTPS base URL bez parametrów zapytania. Parametry zapytania konfiguruje się osobno i mogą używać stałych wartości lub placeholderów.

Obsługiwane placeholdery:

• {phone} - numer telefonu użytkownika.
• {message} - tekst wiadomości SMS.
• {fromName} - skonfigurowana nazwa nadawcy SMS.

Przykład konfiguracji Access URL:

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

FoxIDs wysyła żądanie jako HTTP GET i koduje URL każdej wartości parametru zapytania. API URL jest logowany razem z numerem telefonu. Parametry zapytania nie są logowane. Jeśli dostawca zwróci błąd, FoxIDs loguje numer telefonu, wiadomość SMS, kod statusu HTTP i odpowiedź dostawcy.

Konfiguracja dostawcy SMS w środowisku

Dostawcę SMS można skonfigurować w każdym środowisku, gdzie nazwa nadawcy jest wymagana. Jeśli dostawca SMS jest skonfigurowany w środowisku, jest używany zamiast dowolnego dostawcy SMS skonfigurowanego globalnie.

Access URL

Skonfiguruj Access URL za pomocą API URL i parametrów zapytania wymaganych przez dostawcę SMS. API URL musi być bezwzględnym HTTPS base URL bez parametrów zapytania. Dodaj każdy parametr zapytania osobno i użyj placeholderów tam, gdzie wartość ma zostać wstawiona podczas wysyłania.

Wymagane wartości:

• Type: AccessUrl
• Nazwa nadawcy
• API URL
• Parametry zapytania z co najmniej jednym placeholderem {phone} i jednym placeholderem {message}

Gateway API

Skonfiguruj Gateway API za pomocą endpointu dostawcy i tokenu. Nazwa nadawcy jest wysyłana jako nadawca SMS, a opcjonalna etykieta jest wysyłana do Gateway API.

Wymagane wartości:

• Type: GatewayApi
• Nazwa nadawcy
• API URL
• Client secret

Wartości opcjonalne:

• Label

Smstools

Skonfiguruj Smstools za pomocą endpointu dostawcy, client ID i client secret. Nazwa nadawcy jest wysyłana jako nadawca SMS.

Wymagane wartości:

• Type: Smstools
• Nazwa nadawcy
• API URL
• Client ID
• Client secret

Telia SMS Gateway

Skonfiguruj Telia SMS Gateway za pomocą endpointu dostawcy, sender address, API key i certyfikatu mTLS. Nazwa nadawcy jest wysyłana jako nazwa nadawcy SMS, a client ID jest wysyłany jako sender address.

Wymagane wartości:

• Type: TeliaSmsGateway
• Nazwa nadawcy
• API URL
• Client ID (sender address)
• Client secret (API key)
• Certyfikat mTLS

Globalna konfiguracja dostawcy SMS

Dostawcę SMS można opcjonalnie skonfigurować globalnie w application settings witryny FoxIDs. Nazwa nadawcy jest wymagana.

API URL musi być bezwzględnym HTTPS URL dla wszystkich dostawców SMS. Dla Access URL API URL musi również być base URL bez parametrów zapytania, a parametry zapytania muszą zawierać co najmniej jeden placeholder {phone} i jeden placeholder {message}.

Access URL

Konfiguracja Access URL za pomocą 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}"
      }
    ]
  }
}

Skonfiguruj parametry zapytania Access URL w Parameters. Każdy parametr ma Name i Value. Parametry zapytania muszą zawierać co najmniej jeden placeholder {phone} i jeden placeholder {message}. Placeholderów {phone}, {message} i {fromName} można używać w wartościach parametrów.

Gateway API

Konfiguracja Gateway API za pomocą application settings:

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

ClientSecret jest wysyłany jako token Gateway API. Label jest opcjonalny.

Smstools

Konfiguracja Smstools za pomocą application settings:

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

Telia SMS Gateway

Konfiguracja Telia SMS Gateway za pomocą 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 jest wysyłany jako sender address. ClientSecret jest wysyłany jako API key. Certyfikat i klucz prywatny są używane dla mTLS.

Powiązana dokumentacja

• Dostawca e-mail
• Uwierzytelnianie dwuskładnikowe i wieloskładnikowe
• Login & HRD
• Wdrożenie