Bem-vindo ao Guia de Integração do SDK VerifyNow

Visão geral

Verifique agora é um serviço de verificação e autenticação de números de celular desenvolvido pela Central de mensagens. Ele fornece uma maneira rápida, confiável e econômica de verificar números de celular e executar autenticação multifator (MFA) em todos os canais de SMS e WhatsApp.

No ecossistema digital, os números móveis se tornaram a identidade universal do usuário. Verifique agora permite que seu aplicativo, seja web ou móvel, autentique os números de celular dos usuários com facilidade e segurança.

Características principais

• Verificação multicanal: O VerifyNow oferece suporte à entrega OTP por meio dos canais SMS e WhatsApp.
• Modelos pré-aprovados e IDs de remetente: Os IDs de remetente e os modelos de mensagens já foram aprovados, então você não precisa esperar pela autorização regulatória.
• Recurso automático: Se a entrega da mensagem falhar no canal principal, o sistema tentará automaticamente usar um canal alternativo compatível.
• Opções de SDK e API: Escolha entre a instalação simplificada do SDK ou a integração direta com a API flexível, dependendo de suas necessidades de implementação

Caso de uso: autenticação baseada em OTP

Geração e entrega de OTP

Parâmetros do modelo de mensagem

Os parâmetros a seguir são necessários ao usar as APIs VerifyNow:

O aplicativo corporativo integra a verificação OTP em seu fluxo de trabalho de autenticação, garantindo uma autenticação segura e confiável do usuário. Essa abordagem oferece uma experiência OTP consistente para usuários em todas as regiões suportadas.

Fluxo de verificação

Fluxo de trabalho geral ao integrar o SDK VerifyNow no iOS, Android ou JavaScript:

Por que usar o VerifyNow

Antes de enviar qualquer mensagem SMS ou WhatsApp internacionalmente, as empresas devem obter o ID do remetente e as aprovações dos reguladores de telecomunicações — um processo que pode levar semanas

O VerifyNow elimina essa etapa fornecendo IDs de remetente e modelos pré-aprovados em mais de 200 países, permitindo que os parceiros se integrem e entrem em operação instantaneamente.

Com o VerifyNow, uma única integração abre seu aplicativo para um público global, garantindo conformidade e confiabilidade.

Mecanismo de fallback

O VerifyNow inclui um recurso de fallback para garantir a entrega OTP. Se o canal principal (por exemplo, SMS) falhar, o VerifyNow tentará automaticamente usar um canal alternativo (por exemplo, WhatsApp).

Canais alternativos atualmente suportados:

1. SMS → WhatsApp
2. WhatsApp → (Planejado para lançamento futuro)

Métodos de entrega adicionais fazem parte do roteiro — entre em contato com seu Gerente de contas para atualizações.

Benefícios da integração do SDK (versus API)

Resumo

O uso do SDK VerifyNow fornece:

Próximas etapas

Para integrar usando SDKs, consulte:

Se você já tiver uma conta da Central de Mensagens, recupere suas credenciais do console. Para suporte de integração corporativa ou integração personalizada, entre em contato com seu gerente de contas da Central de Mensagens.

Etapas de integração

Pré-requisitos para integração

Antes de integrar o SDK, certifique-se de ter uma conta ativa na Central de Mensagens. Console central de mensagens

Você precisará das seguintes credenciais:

Essas credenciais são necessárias para iniciar solicitações de verificação. Você os receberá assim que sua conta for criada e aprovada.

Obtenha CustomerID ou AuthToken

Faça login no console do Message Central.Console central de mensagens

Ou gere a API AuthToken

Antes de usar o SDK VerifyNow para verificar, você deve ter “AuthToken”. Essa API retorna um token que deve ser incluído em todas as chamadas subsequentes. É necessário um token de autenticação para validar o usuário e deve ser incluído na seção de cabeçalho de cada solicitação.

Parâmetros da solicitação:

Caminho do URL da solicitação:

1/auth/v1/authentication/token

‍‍

cURL

1cURL curl --location 'https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=< CustomerId>&key=&scope=NEW&country=91&email=test@messagecentral.com' \ --header 'accept: */*'

🚨 NOTA: Para converter um comando cURL em código usando o Postman, abra o Postman, importe o comando cURL por meio do botão “Importar” e gere o código no idioma de sua preferência clicando no botão “Código” no lado direito da solicitação.

Resposta JSON

Uma resposta bem-sucedida retornará um código de status 200

1{
2       "status": Integer,
3       "token": "String"
4}

Integração de SDK para Android (usando arquivo.aar)

Este guia explica como integrar o VerifyNowSDK ao seu projeto Android usando o arquivo.aar local.

SDK para Android — v1.0.0

Etapa 1: adicionar o arquivo.aar

Copie o arquivo VerifyNowSDK-RELEASE-1.0.0.aar no diretório libs/ do módulo do seu aplicativo.

A estrutura do projeto deve ter a seguinte aparência:

Etapa 2: adicionar a dependência do AAR

Adicione isso às dependências build.gradle.kts do seu aplicativo:

dependencies {
 implementation("com.squareup.retrofit2:retrofit:2.11.0")
 implementation("com.squareup.retrofit2:converter-gson:2.11.0") 
 implementation(files("libs/ VerifyNowSDK-release.aar"))
 }

Verifique se o nome corresponde ao nome do arquivo (sem a extensão.aar)

Etapa 3: inicializar o SDK

Depois de sincronizar o projeto e antes de usar qualquer recurso de verificação, certifique-se de que o SDK esteja devidamente inicializado em sua classe de aplicativo ou atividade principal.

Assinatura da função

VerifyNowSDK.init(
     context: Context
 )

Etapa 4: invocar e usar o SDK

Depois de inicializado, você pode iniciar o processo de verificação usando os métodos disponíveis.

Assinatura da função

VerifyNowSDK.verify(
countryCode: String,
mobileNo: String,
customerId: String,
authToken: String,
isFallbackEnable: Boolean = false, // optional
callback: VerificationCallback )

Parâmetros da solicitação:

Esse sinalizador determina se o OTP fallback deve ser usado caso a verificação primária falhe.

• Definido como verdadeiro →O SDK mudará automaticamente para a verificação alternativa baseada em OTP se o Verify Now falhar
• Definido como falso → Nenhum substituto é acionado; a verificação falha

Retorno de chamada: VerificaçãoCallback

Você precisa fornecer uma implementação de VerificationCallback para lidar com o resultado da verificação.

object : VerificationCallback {
override fun success(success: VerificationSuccess)
{// Called when verification succeeds}override fun failure(error: VerificationError)
{// Called when verification fails}
}

import com.messagecentral.verifynow.VerificationCallback
import com.messagecentral.verifynow.VerifyNowSDK
import com.messagecentral.verifynow.network.VerificationError
import com.messagecentral.verifynow.network.VerificationSuccess

VerifyNowSDK.verify(
countryCode
mobileNo
customerId
authToken
isFallbackEnable
callback = object : VerificationCallback
override fun success(success: VerificationSuccess
Toast.makeText(this@MainActivity, "Verified: ${success .verified} message:
${success.message}
",
).show()
}
override fun failure(error: VerificationError) {
Toast.makeText(this@MainActivity, "Failed: ${error.errorMsg}",
).show
}
)

SDK Integration IOS (usando o arquivo.xcframework)

• Nome do SDK: VerifyNowSDK-RELEASE-1.0.0.xcframework
• Arquivo: VerifyNowSDK-RELEASE-1.0.0.xx Framework

Este guia orienta você na integração do VerifyNowSDK em seu projeto IOS usando o arquivo local .xcframework.

SDK para iOS — v1.0.0

• Tipo de lançamento: Lançamento público inicial — fevereiro de 2025
• Compatibilidade:
  • Compatível com iOS 16+
• Características:
  • Funcionalidade principal de verificação OTP
  • Estrutura de retorno de chamada unificada (a sintaxe da linguagem difere da do Android)
• Limitações:
  • Sem suporte para testes de sandbox/simulação

Etapa 1: Adicionar os arquivos da estrutura VerifyNowSDK-RELEASE-1.0.0.xc

Depois de inicializado, você pode iniciar o processo de verificação usando os métodos disponíveis.

Assinatura da função

VerifyNowSDK.verify(
countryCode: String,
mobileNo: String,
customerId: String,
authToken: String,
isFallbackEnable: Bool = false,
completion: @escaping (VerificationResult<VerificationSuccess, VerificationError>)
)

isFallbackEnable: Boolean = false

Esse sinalizador determina se o OTP fallback deve ser usado caso a verificação primária falhe.

• Definido como verdadeiro → O SDK mudará automaticamente para a verificação baseada em OTP se o Verify Now falhar.
• Definido como false → Nenhum fallback é acionado; a verificação falhará se o USSD não for bem-sucedido.

Retorno de chamada: CompletionHandler

Você precisa fornecer uma implementação de conclusão para lidar com o resultado da verificação.

switch result {
        case .success(let success):
             print("Verification result: \(success.status), message: \(success.message)")
        case .failure(let error):
             switch error {
                  case .verificationFailed(let errorCode, let errorMessage):
                      print("Verification failed - Code: \(errorCode), Message: \ (errorMessage)")
            }
           @unknown default:
               print("Unknown")
         } 

success (success: verificationSuccess): invocado na verificação bem-sucedida. O VerificationSuccess pode incluir um status (200), uma mensagem e uma mensagem verificada (verdadeira)

public struct VerificationSuccess: Codable {
    public let status:Int
    public let verified: Bool
    public let message: String
}

falha (erro: verificationError): invocado quando a verificação falha. O VerificationError contém o ErrorCode e o ErrorMessage.

public enum VerificationError: Error {
    case verificationFailed(errorCode: Int, errorMsg: String)
}

Exemplo de uso:

VerifyNowSDK.verify(countryCode: countryCode,
                    mobileNo: mobileNo,
                    customerId: customerId,
                     authToken: authToken,
                     isFallbackEnable: isFallbackEnable) { result in
   switch result {
        case .success(let success):
                 print("Verification result: \(success.status), message: \(success.message)")
        case .failure(let error):
                 switch error {
                      case .verificationFailed(let errorCode, let errorMsg):
                            print("Verification failed - Code: \(errorCode), Message: \ (errorMsg)")
            }
           @unknown default:
               print("Unknown")
         }

🚨 NOTA:

Suporte

Email de contato: support@messagecentral.com