Validação de OTP para Acesso de Convidado
Descrição
Permite que um convidado valide um código OTP para acessar um evento específico. O código OTP deve ser enviado via JSON no corpo da requisição.
Verbo
POST
URL Base
https://api.soargi.com
Endpoint
/guest/validate-otp
Cabeçalhos
Parâmetro | Valor |
---|---|
Content-Type | application/json |
Corpo da Requisição
{
"otp": "123456"
}
Sucesso - 200 (OTP válido)
{
"success": true,
"message": "Access granted. Valid OTP.",
"event_id": 1,
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}
Sobre o Token JWT
Ao validar o OTP com sucesso, a resposta inclui um token JWT temporário válido por 2 horas. Este token deve ser enviado no cabeçalho Authorization: Bearer <token>
para acessar rotas privadas enquanto estiver válido.
- O token expira em 2 horas após a geração (
exp
). - Payload típico:
{ "event_id": 1, "iat": 1710000000, "exp": 1710007200 }
- Utilize o token para autenticação temporária de convidados.
Erro - 403 (OTP inválido)
{
"status": 403,
"messages": {
"error": "Access denied: invalid OTP code."
}
}
Erro - 422 (Campo obrigatório)
{
"status": 422,
"messages": {
"otp": "The otp field is required."
}
}
Códigos de Resposta
- 200 - OTP válido, acesso permitido
- 403 - OTP inválido, acesso negado
- 422 - Campo obrigatório ausente