Fornecedor de SMS

O FoxIDs suporta o envio de mensagens SMS com Access URL, Gateway API, Smstools e Telia SMS Gateway. O fornecedor de SMS pode ser configurado como fornecedor de SMS em cada ambiente ou globalmente na configuração do site FoxIDs.

O FoxIDs envia mensagens SMS aos utilizadores para códigos de verificação, login sem palavra-passe e autenticação multifator quando SMS está ativado no fluxo de login.

O FoxIDs inclui fornecedores de SMS standard para APIs de fornecedores suportadas e um fornecedor de SMS genérico Access URL para fornecedores que não estão integrados. Use os fornecedores standard quando a API do fornecedor corresponder a uma das integrações suportadas. Use Access URL quando o fornecedor puder receber um pedido HTTPS GET com parâmetros de query específicos do fornecedor.

Access URL

O fornecedor Access URL é um fornecedor genérico para integrações SMS flexíveis. Chama um endpoint HTTPS específico do fornecedor com os parâmetros de query exigidos pelo fornecedor de SMS concreto. A API URL é uma base URL HTTPS absoluta sem parâmetros de query. Os parâmetros de query são configurados separadamente e podem usar valores fixos ou placeholders.

Placeholders suportados:

• {phone} - o número de telefone do utilizador.
• {message} - o texto da mensagem SMS.
• {fromName} - o nome de remetente SMS configurado.

Exemplo de configuração Access URL:

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

O FoxIDs envia o pedido como HTTP GET e codifica em URL cada valor de parâmetro de query. A API URL é registada juntamente com o número de telefone. Os parâmetros de query não são registados. Se o fornecedor devolver um erro, o FoxIDs regista o número de telefone, a mensagem SMS, o código de estado HTTP e a resposta do fornecedor.

Configurar fornecedor de SMS no ambiente

O fornecedor de SMS pode ser configurado em cada ambiente, onde o nome do remetente é obrigatório. Se um fornecedor de SMS estiver configurado no ambiente, é usado em vez de qualquer fornecedor de SMS configurado globalmente.

Access URL

Configure Access URL com uma API URL e os parâmetros de query exigidos pelo fornecedor de SMS. A API URL deve ser uma base URL HTTPS absoluta sem parâmetros de query. Adicione cada parâmetro de query separadamente e use placeholders onde o valor deve ser inserido no momento do envio.

Valores obrigatórios:

• Type: AccessUrl
• Nome do remetente
• API URL
• Parâmetros de query com pelo menos um placeholder {phone} e um placeholder {message}

Gateway API

Configure Gateway API com o endpoint do fornecedor e o token. O nome do remetente é enviado como remetente do SMS, e a label opcional é enviada para a Gateway API.

Valores obrigatórios:

• Type: GatewayApi
• Nome do remetente
• API URL
• Client secret

Valores opcionais:

• Label

Smstools

Configure Smstools com o endpoint do fornecedor, client ID e client secret. O nome do remetente é enviado como remetente do SMS.

Valores obrigatórios:

• Type: Smstools
• Nome do remetente
• API URL
• Client ID
• Client secret

Telia SMS Gateway

Configure Telia SMS Gateway com o endpoint do fornecedor, endereço do remetente, API key e certificado mTLS. O nome do remetente é enviado como nome do remetente SMS, e o client ID é enviado como endereço do remetente.

Valores obrigatórios:

• Type: TeliaSmsGateway
• Nome do remetente
• API URL
• Client ID (endereço do remetente)
• Client secret (API key)
• Certificado mTLS

Configurar fornecedor de SMS globalmente

O fornecedor de SMS pode opcionalmente ser configurado globalmente nas application settings do site FoxIDs. O nome do remetente é obrigatório.

A API URL deve ser uma URL HTTPS absoluta para todos os fornecedores de SMS. Para Access URL, a API URL deve também ser uma base URL sem parâmetros de query, e os parâmetros de query devem incluir pelo menos um placeholder {phone} e um placeholder {message}.

Access URL

Configurar Access URL com 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 os parâmetros de query Access URL em Parameters. Cada parâmetro tem um Name e um Value. Os parâmetros de query devem incluir pelo menos um placeholder {phone} e um placeholder {message}. Os placeholders {phone}, {message} e {fromName} podem ser usados nos valores dos parâmetros.

Gateway API

Configurar Gateway API com application settings:

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

ClientSecret é enviado como token da Gateway API. Label é opcional.

Smstools

Configurar Smstools com 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 com 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 é enviado como endereço do remetente. ClientSecret é enviado como API key. O certificado e a chave privada são usados para mTLS.

Documentação relacionada

• Fornecedor de email
• Autenticação de dois fatores e multifator
• Login & HRD
• Deployment