loader
qloud

Autenticação


A autenticação é feita por key, uma sequência composta de até 128 caracteres. Em cada requisição seja ela feita via POST, GET ou JSON o parâmetro key deve ser configurado com sua chave.

Obter Chave Key

Se você já tem uma conta, acesse https://painel.smstoken.com.br/configuracao/conta/perfil Subcontas tem sua própria Chave Key, basta realizar o login pela Subconta e acessar a mesma url acima.

Alteração Chave Key

Para alteração é necessário solicitação via e-mail para suporte@smstoken.com.br.

Criar Conta

Crie uma conta gratuitamente em https://painel.smstoken.com.br/criar-conta.

Verify


Endpoint: https://api.smstoken.com.br/token/v1/verify
Método: POST
Descrição: Requisita envio de mensagem com código para autenticação two-factor.

{
    "key" : "XXXXXXXXXXXXXXXXX",
	"number":"5511988887777",
	"template" : "<#> Seu código de verificação é: {999-999}",
	"expire" : 120
}

Parâmetro

Tipo

Padrão

Obrigatório

Descrição

key

texto

sim

Chave de autenticação de conta.

number

número

sim

Número destinatário formato internacional.

template

texto

<#> Seu código de verificação é: {999-999}

não

Template da mensagem com variável personalizável. Ex: {999-999}

code

número


não

Código a ser enviado, se nulo código gerado automaticamente.

expire

número

180

não

Tempo de validade do código em segundos.

refer

texto

250

não

Texto extra retornado pelo método check em caso verdadeiro. 

{
    "situacao": "OK",
    "id": "771037704",
    "mensagem": "<#> Seu código de verificação é: 930-931",
    "code": "930931",
    "descricao": "TOKEN ENVIADO COM SUCESSO"
}

Check


Endpoint: https://api.smstoken.com.br/token/v1/check
Método: POST
Descrição: Verifica se o código informado é válido e não esta expirado.

{
    "key" : "XXXXXXXXXXXXXXXXX",
    "number":"5511988887777",
	"code" : 930931
}

Parâmetro

Tipo

Padrão

Obrigatório

Descrição

key

texto

sim

Chave de autenticação de conta.

number

número

sim

Número destinatário formato internacional.

code

número


sim

Código a ser validado.

{
    "situacao": "OK",
    "checked": true,
    "descricao": "CODIGO VALIDADO COM SUCESSO"
}