Usuário

Nesta seção estão descritas as APIs que gerenciam os dados do usuário.

A rota da API para sandbox é: https://2fa-sandbox.zoop.ws

Os endpoints para a utilização de validação por e-mail ainda estão em desenvolvimento.

post
Registrar e-mail e celular para um usuário

https://2fa.zoop.ws/v1/api/user
Request
Response
Request
Headers
x-api-key
required
string
My X-API-Key
X-Auth-Token
required
string
My X-Auth-Token
Body Parameters
ApplicationToken
required
string
Token da aplicação em que o usuário tem acesso. Mascara: AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
CellPhone
required
number
Telefone do usuário
Email
required
string
E-mail do usuário
UniqueIdentifier
required
string
Código de identificação única do usuário. Exemplo: 12345678910
Response
200: OK
{
"UserToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"UniqueIdentifier": “12345678910”,
"CellPhone": “5521987654321”,
"CellPhoneValidated": false
"Email": "[email protected]",
"EmailValidated": false,
"CreationDate": "2020-01-01T12:00:00.000000Z"
}
401: Unauthorized
Token is expired, Token invalid or incorrect secret, Token invalid
412: Precondition Failed
Application Token incorrect number
Application Token not found
CellPhone not found
CellPhone not numeric
CellPhone incorrect number
Email incorrect length
Email not found
Unique Identifier min length X
Unique Identifier not found
User already exists.
{
"ApplicationToken":"AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"CellPhone":"5521987654321",
"Email":"[email protected]",
"UniqueIdentifier":"12345678910"
}

post
Registrar celular para um usuário

https://2fa.zoop.ws/v1/api/user/cellphone
Request
Response
Request
Headers
x-api-key
required
string
My X-API-Key
X-Auth-Token
required
string
My X-Auth-Token
Body Parameters
ApplicationToken
required
string
Token da aplicação. Mascara: AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
CellPhone
required
number
Telefone do usuário
UniqueIdentifier
required
string
Código de identificação única do usuário. Exemplo: 12345678910
Response
200: OK
{
"UserToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"UniqueIdentifier": “12345678910”,
"CellPhone": “5521987654321”,
"CellPhoneValidated": false,
"CreationDate": "2020-01-01T12:00:00.000000Z"
}
401: Unauthorized
Token is expired, Token invalid or incorrect secret, Token invalid
412: Precondition Failed
Application not found
UniqueIdentifier min length X
Unique Identifier not found
User already exists.
{
"ApplicationToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"CellPhone": “5521987654321”,
"UniqueIdentifier": “12345678910”
}

post
Inserir os dados de usuário para autenticação por e-mail

https://2fa.zoop.ws/v1/api/user/email
Insere os dados de e-mail do usuário a ser autenticado.
Request
Response
Request
Headers
x-api-key
required
string
My X-API-Key
X-Auth-Token
required
string
My X-Auth-Token
Body Parameters
ApplicationToken
required
string
Token da aplicação. Mascara: AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
Email
required
string
E-mail do usuário
UniqueIdentifier
required
string
Código de identificação único do usuário. Exemplo: 12345678910
Response
200: OK
{
"UserToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"UniqueIdentifier": “12345678910”,
"Email": “[email protected]”,
"EmailValidated": false,
"CreationDate": "2020-01-01T12:00:00.000000Z"
}
401: Unauthorized
Token is expired, Token invalid or incorrect secret, Token invalid
412: Precondition Failed
Application Token incorrect number
Application Token not found
Unique Identifier not found
UniqueIdentifier min length X
User not exists
{
"ApplicationToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"Email": “[email protected]”,
"UniqueIdentifier": “12345678910”
}

post
Inserir dados de usuário para autenticação TOTP

https://2fa.zoop.ws/v1/api/user/totp
Request
Response
Request
Headers
x-api-key
required
string
X-API-Key
X-Auth-Token
required
string
My X-Auth-Token
Body Parameters
UserSessionToken
required
string
Token de sessão do usuário. Mascara: AAAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
UserToken
required
string
Token do usuário. Mascara: AAAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
KeyType
required
string
Tipo de chave. Usar RSA/ECB/PKCS1Padding
KeyPublic
required
string
Chave publica do TOTP. Usar RSA/ECB/PKCS1Padding Key Public
Response
200: OK
{
"UserToken":"AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"PasswordLength": 6,
"SeedRSA":"Seed RSA Public Key"
}
401: Unauthorized
Token is expired, Token invalid or incorrect secret, Token
invalid
412: Precondition Failed
Application Token incorrect number
Application Token not found
Unique Identifier not found
UniqueIdentifier min length X
User not exists.
{
"UserSessionToken": "AAAAAAA-BBBB-CCCC-DDDD-
EEEEEEEEEEEE",
"UserToken": "AAAAAAA-BBBB-CCCC-DDDD-
EEEEEEEEEEEE",
"KeyType":"RSA/ECB/PKCS1Padding",
"KeyPublic": "RSA/ECB/PKCS1Padding Key Public"
}

SeedRSA está em base64 e precisa sofrer um decode antes da descriptografia com a chave privada, após a descriptografia com a chave privada o Seed que ela contém deverá sofre um decode para UTF-8

put
Atualizar celular de usuário

https://2fa.zoop.ws/v1/api/user/cellphone
Atualiza os dados do telefone celular do usuário a ser autenticado.
Request
Response
Request
Headers
x-api-key
required
string
X-API-Key
X-Auth-Token
required
string
My X-Auth-Token
Body Parameters
ApplicationToken
required
string
Token da aplicação. Mascara: AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
CellPhone
required
number
Telefone do usuário
UniqueIdentifier
required
string
Código de identificação única do usuário. Exemplo: 12345678910
Response
200: OK
{
"UserToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"UniqueIdentifier": “12345678910”,
"CellPhone": “5521987654321”,
"CellPhoneValidated": false
"CreationDate": "2020-01-01T12:00:00.000000Z",
}
401: Unauthorized
Token is expired, Token invalid or incorrect secret, Token invalid
412: Precondition Failed
Application Token incorrect number
Application Token not found
CellPhone incorrect number
CellPhone not numeric
Unique Identifier not found
UniqueIdentifier min length X
User not exists
{
"ApplicationToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"CellPhone": “5521987654321”,
"UniqueIdentifier": “12345678910”
}

put
Atualizar e-mail de usuário

https://2fa.zoop.ws/v1/api/user/email
Atualizar os dados de e-mail do usuário a ser autenticado.
Request
Response
Request
Headers
x-api-key
required
string
My X-API-Key
X-Auth-Token
required
string
My X-Auth-Token
Body Parameters
ApplicationToken
required
string
Token da aplicação. Mascara: AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
Email
required
string
E-mail do usuário
UniqueIdentifier
required
string
Código de identificação único do usuário. Exemplo: 12345678910
Response
200: OK
{
"UserToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"UniqueIdentifier": “12345678910”,
"Email": “[email protected]”,
"EmailValidated": false,
"CreationDate": "2020-01-01T12:00:00.000000Z"
}
401: Unauthorized
Token is expired, Token invalid or incorrect secret, Token invalid
412: Precondition Failed
Application Token incorrect number
Application Token not found
Unique Identifier not found
UniqueIdentifier min length X
User not exists
{
"ApplicationToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"Email": “[email protected]”,
"UniqueIdentifier": “12345678910”
}

put
Atualizar celular validado de usuário

https://2fa.zoop.ws/v1/api/user/change/cellphone
Atualiza os dados de celular já validado do usuário a ser autenticado por outro. Para isso o usuário deve ter um e-mail validado. O Token será enviado por e-mail e a validação do Token deve ser feita na chamada POST - user/cellphone/validate.
Request
Response
Request
Headers
x-api-key
required
string
My X-API-Key
X-Auth-Token
required
string
My X-Auth-Token
Body Parameters
ApplicationToken
required
string
Token da aplicação. Mascara: AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
CellPhone
required
number
Telefone do usuário
UniqueIdentifier
required
string
Código de identificação único do usuário. Exemplo: 12345678910
Response
200: OK
{
"UserToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"UniqueIdentifier": “12345678910”,
"Email": "[email protected]",
"EmailValidated": true,
"CellPhoneFrom": "5521987654321",
"CellPhoneFromValidated": true,
"CellPhoneTo": "5521123456789",
"CellPhoneToValidated": false,
"CreationDate": "2020-01-01T13:00:00.000000Z"
}
401: Unauthorized
Token is expired, Token invalid or incorrect secret, Token invalid
412: Precondition Failed
Application Token incorrect number
Application Token not found
CellPhone incorrect number
CellPhone not numeric
Unique Identifier not found
Unique Identifier min length X
User not exists.
{
"ApplicationToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"CellPhone": “5521987654321”,
"UniqueIdentifier": “12345678910”
}

put
Atualizar e-mail validado de usuário

https://2fa.zoop.ws/v1/api/user/change/email
Atualiza os dados do e-mail já validado do usuário a ser autenticado por outro. Para isso o usuário deve ter um celular validado. O Token será enviado por SMS e a validação do Token deve ser feita na chamada POST - user/email/validate.
Request
Response
Request
Headers
x-api-key
required
string
My X-API-Key
X-Auth-Token
required
string
My X-Auth-Token
Body Parameters
ApplicationToken
required
string
Token da aplicação. Mascara: AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
Email
required
string
E-mail do usuário
UniqueIdentifier
required
string
Código de identificação do usuário. Exemplo: 12345678910
Response
200: OK
{
"UserToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"UniqueIdentifier": “12345678910”,
"CellPhone": "5521987654321",
"CellPhoneValidated": true,
"EmailFrom": "[email protected]",
"EmailFromValidated": true,
"EmailTo": "[email protected]",
"EmailToValidated": false,
"CreationDate": "2020-01-01T23:00:00.000000Z",
}
401: Unauthorized
Token is expired, Token invalid or incorrect secret, Token invalid
412: Precondition Failed
Application Token incorrect number
Application Token not found
E-mail not found
E-mail incorrect length
Unique Identifier not found
UniqueIdentifier min length X
User not exists
{
"ApplicationToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"Email": “[email protected]”,
"UniqueIdentifier": “12345678910”
}

get
Obter os dados do usuário

https://2fa.zoop.ws/v1/api/user
Retorna todos os dados do cliente para uma aplicação.
Request
Response
Request
Headers
x-api-key
required
string
My X-API-Key
X-Auth-Token
required
string
My X-Auth-Token
Query Parameters
ApplicationToken
required
string
Token da Aplicação. Mascara: AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
UniqueIdentifier
required
string
Código de identificação único do usuário. Exemplo: 12345678910
Response
200: OK
{
"UserToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"UniqueIdentifier": "00000000001",
"CellPhone": "5521987654321",
"CellPhoneValidated": false,
"Email": "[email protected]",
"EmailValidated": false,
"CreationDate": "2020-01-01T12:00:00.000000Z"
}
401: Unauthorized
Token is expired, Token invalid or incorrect secret, Token invalid
412: Precondition Failed
Application not found
User does not exist for this application

get
Obter dados de celular de usuário

https://2fa.zoop.ws/v1/api/user/cellphone
Retorna os dados do usuário, celular e se o número foi validado.
Request
Response
Request
Headers
x-api-key
required
string
My X-API-Key
X-Auth-Token
required
string
My X-Auth-Token
Query Parameters
ApplicationToken
required
string
Token da aplicação. Mascara: AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
UniqueIdentifier
required
string
Código de identificação único do usuário. Exemplo: 12345678910
Response
200: OK
{
"UserToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"UniqueIdentifier": "00000000001",
"CellPhone": "5521987654321",
"CellPhoneValidated": false,
"CreationDate": "2020-01-01T12:00:00.000000Z"
}
401: Unauthorized
Token is expired, Token invalid or incorrect secret, Token invalid
412: Precondition Failed
Application Token incorrect number
Application Token not found
User does not exist for this application

get
Obter dados de e-mail de usuário

https://2fa.zoop.ws/v1/api/user/email
Retorna os dados de e-mail do usuário.
Request
Response
Request
Headers
x-api-key
required
string
My X-API-Key
X-Auth-Token
required
string
My X-Auth-Token
Query Parameters
ApplicationToken
required
string
Token da aplicação. Mascara: AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE
UniqueIdentifier
required
string
Código de identificação único do usuário. Exemplo: 12345678910
Response
200: OK
{
"UserToken": "AAAAAAA-BBBB-CCCC-DDDD-EEEEEEEEEEEE",
"UniqueIdentifier": "00000000001",
"Email": "[email protected]",
"EmailValidated": false,
"CreationDate": "2020-03-11T07:10:45.000000Z"
"CreationDate": "2020-01-01T12:00:00.000000Z"
}