SMS-leverandør

FoxIDs støtter sending av SMS-meldinger med Access URL, Gateway API, Smstools og Telia SMS Gateway. SMS-leverandøren kan konfigureres som SMS-leverandør i hvert miljø eller generelt i FoxIDs site-konfigurasjonen.

FoxIDs sender SMS-meldinger til brukere for verifiseringskoder, passordløs innlogging og flerfaktorautentisering når SMS er aktivert i innloggingsflyten.

FoxIDs inkluderer standard SMS-leverandører for støttede leverandør-API-er og en generisk Access URL SMS-leverandør for leverandører som ikke er innebygd. Bruk standardleverandørene når leverandørens API samsvarer med en av de støttede integrasjonene. Bruk Access URL når leverandøren kan motta en HTTPS GET-forespørsel med leverandørspesifikke query-parametere.

Access URL

Access URL-leverandøren er en generisk leverandør for fleksible SMS-integrasjoner. Den kaller et leverandørspesifikt HTTPS-endepunkt med query-parametrene som den konkrete SMS-leverandøren krever. API URL-en er en absolutt HTTPS base URL uten query-parametere. Query-parametere konfigureres separat og kan bruke faste verdier eller placeholders.

Støttede placeholders:

• {phone} - brukerens telefonnummer.
• {message} - SMS-meldingsteksten.
• {fromName} - det konfigurerte SMS-avsendernavnet.

Eksempel på Access URL-konfigurasjon:

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

FoxIDs sender forespørselen som HTTP GET og URL-enkoder hver query-parameterverdi. API URL-en logges sammen med telefonnummeret. Query-parametere logges ikke. Hvis leverandøren returnerer en feil, logger FoxIDs telefonnummer, SMS-melding, HTTP-statuskode og leverandørens response.

Konfigurer SMS-leverandør i miljø

SMS-leverandøren kan konfigureres i hvert miljø, der avsendernavnet er påkrevd. Hvis en SMS-leverandør er konfigurert i miljøet, brukes den i stedet for en generelt konfigurert SMS-leverandør.

Access URL

Konfigurer Access URL med en API URL og query-parametrene som SMS-leverandøren krever. API URL-en må være en absolutt HTTPS base URL uten query-parametere. Legg til hver query-parameter separat, og bruk placeholders der verdien skal settes inn ved sending.

Påkrevde verdier:

• Type: AccessUrl
• Avsendernavn
• API URL
• Query-parametere med minst én {phone} placeholder og én {message} placeholder

Gateway API

Konfigurer Gateway API med leverandørens endepunkt og token. Avsendernavnet sendes som SMS-avsender, og valgfritt label sendes til Gateway API.

Påkrevde verdier:

• Type: GatewayApi
• Avsendernavn
• API URL
• Client secret

Valgfrie verdier:

• Label

Smstools

Konfigurer Smstools med leverandørens endepunkt, client ID og client secret. Avsendernavnet sendes som SMS-avsender.

Påkrevde verdier:

• Type: Smstools
• Avsendernavn
• API URL
• Client ID
• Client secret

Telia SMS Gateway

Konfigurer Telia SMS Gateway med leverandørens endepunkt, sender address, API key og mTLS-sertifikat. Avsendernavnet sendes som SMS-avsendernavn, og client ID sendes som sender address.

Påkrevde verdier:

• Type: TeliaSmsGateway
• Avsendernavn
• API URL
• Client ID (sender address)
• Client secret (API key)
• mTLS-sertifikat

Konfigurer SMS-leverandør generelt

SMS-leverandøren kan valgfritt konfigureres generelt i FoxIDs site application settings. Avsendernavnet er påkrevd.

API URL-en må være en absolutt HTTPS URL for alle SMS-leverandører. For Access URL må API URL-en også være en base URL uten query-parametere, og query-parametrene må inneholde minst én {phone} placeholder og én {message} placeholder.

Access URL

Konfigurere Access URL med 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}"
      }
    ]
  }
}

Konfigurer Access URL query-parametere i Parameters. Hver parameter har et Name og en Value. Query-parametrene må inneholde minst én {phone} placeholder og én {message} placeholder. Placeholderne {phone}, {message} og {fromName} kan brukes i parameterverdier.

Gateway API

Konfigurere Gateway API med application settings:

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

ClientSecret sendes som Gateway API-token. Label er valgfritt.

Smstools

Konfigurere Smstools med application settings:

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

Telia SMS Gateway

Konfigurere Telia SMS Gateway med 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 sendes som sender address. ClientSecret sendes som API key. Sertifikatet og den private nøkkelen brukes for mTLS.

Relatert dokumentasjon

• E-postleverandør
• To-faktor- og flerfaktorautentisering
• Login & HRD
• Deployment