Fournisseur SMS
FoxIDs prend en charge l'envoi de SMS avec Access URL, Gateway API, Smstools et Telia SMS Gateway. Le fournisseur SMS peut être configuré comme fournisseur SMS dans chaque environnement ou globalement dans la configuration du site FoxIDs.
FoxIDs envoie des SMS aux utilisateurs pour les codes de vérification, la connexion sans mot de passe et l'authentification multi-facteur lorsque SMS est activé dans le flux de connexion.
FoxIDs inclut des fournisseurs SMS standard pour les APIs de fournisseur prises en charge et un fournisseur SMS Access URL générique pour les fournisseurs qui ne sont pas intégrés. Utilisez les fournisseurs standard lorsque l'API du fournisseur correspond à l'une des intégrations prises en charge. Utilisez Access URL lorsque le fournisseur peut recevoir une requête HTTPS GET avec des paramètres de requête propres au fournisseur.
Access URL
Le fournisseur Access URL est un fournisseur générique pour des intégrations SMS flexibles. Il appelle un endpoint HTTPS propre au fournisseur avec les paramètres de requête requis par le fournisseur SMS concret. L'API URL est une URL de base HTTPS absolue sans paramètres de requête. Les paramètres de requête sont configurés séparément et peuvent utiliser des valeurs fixes ou des placeholders.
Placeholders pris en charge :
{phone}- le numéro de téléphone de l'utilisateur.{message}- le texte du SMS.{fromName}- le nom d'expéditeur SMS configuré.
Exemple de configuration Access URL :
- API URL :
https://some-provider.dk/sms/ username=xxxxxxpassword=yyyyyyrecipient={phone}from=zzzzzzou{fromName}message={message}
FoxIDs envoie la requête en HTTP GET et encode chaque valeur de paramètre de requête dans l'URL. L'API URL est journalisée avec le numéro de téléphone. Les paramètres de requête ne sont pas journalisés. Si le fournisseur retourne une erreur, FoxIDs journalise le numéro de téléphone, le SMS, le code de statut HTTP et la réponse du fournisseur.
Configurer le fournisseur SMS dans l'environnement
Le fournisseur SMS peut être configuré dans chaque environnement, où le nom d'expéditeur est obligatoire. Si un fournisseur SMS est configuré dans l'environnement, il est utilisé à la place de tout fournisseur SMS configuré globalement.
Access URL
Configurez Access URL avec une API URL et les paramètres de requête requis par le fournisseur SMS. L'API URL doit être une URL de base HTTPS absolue sans paramètres de requête. Ajoutez chaque paramètre de requête séparément et utilisez des placeholders lorsque la valeur doit être insérée au moment de l'envoi.
Valeurs obligatoires :
- Type:
AccessUrl - Nom d'expéditeur
- API URL
- Paramètres de requête avec au moins un placeholder
{phone}et un placeholder{message}
Gateway API
Configurez Gateway API avec l'endpoint du fournisseur et le token. Le nom d'expéditeur est envoyé comme expéditeur SMS, et le label facultatif est envoyé à Gateway API.
Valeurs obligatoires :
- Type:
GatewayApi - Nom d'expéditeur
- API URL
- Client secret
Valeurs facultatives :
- Label
Smstools
Configurez Smstools avec l'endpoint du fournisseur, le client ID et le client secret. Le nom d'expéditeur est envoyé comme expéditeur SMS.
Valeurs obligatoires :
- Type:
Smstools - Nom d'expéditeur
- API URL
- Client ID
- Client secret
Telia SMS Gateway
Configurez Telia SMS Gateway avec l'endpoint du fournisseur, sender address, API key et certificat mTLS. Le nom d'expéditeur est envoyé comme nom d'expéditeur SMS, et le client ID est envoyé comme sender address.
Valeurs obligatoires :
- Type:
TeliaSmsGateway - Nom d'expéditeur
- API URL
- Client ID (sender address)
- Client secret (API key)
- Certificat mTLS
Configurer le fournisseur SMS globalement
Le fournisseur SMS peut éventuellement être configuré globalement dans les application settings du site FoxIDs. Le nom d'expéditeur est obligatoire.
L'API URL doit être une URL HTTPS absolue pour tous les fournisseurs SMS. Pour Access URL, l'API URL doit également être une URL de base sans paramètres de requête, et les paramètres de requête doivent inclure au moins un placeholder {phone} et un placeholder {message}.
Access URL
Configurer Access URL avec les 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}"
}
]
}
}
Configurez les paramètres de requête Access URL dans Parameters. Chaque paramètre a un Name et une Value. Les paramètres de requête doivent inclure au moins un placeholder {phone} et un placeholder {message}. Les placeholders {phone}, {message} et {fromName} peuvent être utilisés dans les valeurs de paramètre.
Gateway API
Configurer Gateway API avec les application settings :
"Settings": {
"Sms": {
"Type": "GatewayApi",
"FromName": "My-sender",
"ApiUrl": "https://gatewayapi.eu/rest/mtsms",
"ClientSecret": "gateway-api-token",
"Label": "FoxIDs"
}
}
ClientSecret est envoyé comme token Gateway API. Label est facultatif.
Smstools
Configurer Smstools avec les application settings :
"Settings": {
"Sms": {
"Type": "Smstools",
"FromName": "My-sender",
"ApiUrl": "https://app.smstools.com",
"ClientId": "client-id",
"ClientSecret": "client-secret"
}
}
Telia SMS Gateway
Configurer Telia SMS Gateway avec les 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 est envoyé comme sender address. ClientSecret est envoyé comme API key. Le certificat et la clé privée sont utilisés pour mTLS.