Proveedor de SMS
FoxIDs admite el envío de mensajes SMS con Access URL, Gateway API, Smstools y Telia SMS Gateway. El proveedor de SMS se puede configurar como proveedor de SMS en cada entorno o de forma general en la configuración del sitio FoxIDs.
FoxIDs envía mensajes SMS a los usuarios para códigos de verificación, inicio de sesión sin contraseña y autenticación multifactor cuando SMS está habilitado en el flujo de inicio de sesión.
FoxIDs incluye proveedores SMS estándar para APIs de proveedor compatibles y un proveedor SMS genérico Access URL para proveedores que no están integrados. Use los proveedores estándar cuando la API del proveedor coincida con una de las integraciones compatibles. Use Access URL cuando el proveedor pueda recibir una solicitud HTTPS GET con parámetros de consulta específicos del proveedor.
Access URL
El proveedor Access URL es un proveedor genérico para integraciones SMS flexibles. Llama a un endpoint HTTPS específico del proveedor con los parámetros de consulta requeridos por el proveedor SMS concreto. La API URL es una URL base HTTPS absoluta sin parámetros de consulta. Los parámetros de consulta se configuran por separado y pueden usar valores fijos o placeholders.
Placeholders admitidos:
{phone}- el número de teléfono del usuario.{message}- el texto del mensaje SMS.{fromName}- el nombre de remitente SMS configurado.
Ejemplo de configuración de Access URL:
- API URL:
https://some-provider.dk/sms/ username=xxxxxxpassword=yyyyyyrecipient={phone}from=zzzzzzo{fromName}message={message}
FoxIDs envía la solicitud como HTTP GET y codifica en URL cada valor de parámetro de consulta. La API URL se registra junto con el número de teléfono. Los parámetros de consulta no se registran. Si el proveedor devuelve un error, FoxIDs registra el número de teléfono, el mensaje SMS, el código de estado HTTP y la respuesta del proveedor.
Configurar proveedor de SMS en entorno
El proveedor de SMS se puede configurar en cada entorno, donde el nombre del remitente es obligatorio. Si un proveedor de SMS está configurado en el entorno, se usa en lugar de cualquier proveedor de SMS configurado de forma general.
Access URL
Configure Access URL con una API URL y los parámetros de consulta requeridos por el proveedor de SMS. La API URL debe ser una URL base HTTPS absoluta sin parámetros de consulta. Añada cada parámetro de consulta por separado y use placeholders donde el valor deba insertarse en el momento del envío.
Valores obligatorios:
- Type:
AccessUrl - Nombre del remitente
- API URL
- Parámetros de consulta con al menos un placeholder
{phone}y un placeholder{message}
Gateway API
Configure Gateway API con el endpoint y token del proveedor. El nombre del remitente se envía como remitente SMS, y la etiqueta opcional se envía a Gateway API.
Valores obligatorios:
- Type:
GatewayApi - Nombre del remitente
- API URL
- Client secret
Valores opcionales:
- Label
Smstools
Configure Smstools con el endpoint del proveedor, client ID y client secret. El nombre del remitente se envía como remitente SMS.
Valores obligatorios:
- Type:
Smstools - Nombre del remitente
- API URL
- Client ID
- Client secret
Telia SMS Gateway
Configure Telia SMS Gateway con el endpoint del proveedor, sender address, API key y certificado mTLS. El nombre del remitente se envía como nombre de remitente SMS, y el client ID se envía como sender address.
Valores obligatorios:
- Type:
TeliaSmsGateway - Nombre del remitente
- API URL
- Client ID (sender address)
- Client secret (API key)
- Certificado mTLS
Configurar proveedor de SMS de forma general
El proveedor de SMS se puede configurar opcionalmente de forma general en los application settings del sitio FoxIDs. El nombre del remitente es obligatorio.
La API URL debe ser una URL HTTPS absoluta para todos los proveedores SMS. Para Access URL, la API URL también debe ser una URL base sin parámetros de consulta, y los parámetros de consulta deben incluir al menos un placeholder {phone} y un placeholder {message}.
Access URL
Configurar 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}"
}
]
}
}
Configure los parámetros de consulta de Access URL en Parameters. Cada parámetro tiene un Name y un Value. Los parámetros de consulta deben incluir al menos un placeholder {phone} y un placeholder {message}. Los placeholders {phone}, {message} y {fromName} se pueden usar en valores de parámetro.
Gateway API
Configurar 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 se envía como token de Gateway API. Label es opcional.
Smstools
Configurar 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
Configurar 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 se envía como sender address. ClientSecret se envía como API key. El certificado y la clave privada se usan para mTLS.