API Signal - REM Tools (1.0)

Download OpenAPI specification:Download

Soporte REM: soporte@rem.tools

API Signal

API Signal es el servicio de notificaciones y gestión de One Time Password (OTP) de REM Tools.

Características principales

📱 Gestión de OTP: Generación, verificación y validación de códigos de un solo uso
🔐 Seguridad: Autenticación mediante API Key

Autenticación

Todas las peticiones a endpoints protegidos requieren incluir el header Rem-Apikey con tu clave de API válida.

Ambientes disponibles

Producción: https://api.rem.tools/otp
Testing: https://api.test.rem.tools/otp

Soporte

Para asistencia técnica, contacta a nuestro equipo en soporte@rem.tools

OTP

Enviar OTP por Email

Genera y envía un código OTP (One Time Password) de 6 dígitos al correo electrónico especificado usando Amazon SES.

Características:

Código de 6 dígitos generado aleatoriamente
Tiempo de expiración configurable (formato: 5m, 1h, etc.)
Email en formato HTML y texto plano
Personalización de empresa remitente y nombre de usuario

Códigos de error:

ERR001: Error de validación en el request
ERR002: Tiempo de expiración inválido
ERR003: Error al crear/enviar el OTP

Authorizations:

ApiKeyAuth

Request Body schema: application/json

Datos para enviar OTP por email

email required	string Correo electrónico
expires_in required	string Tiempo de expiración del OTP ejem: 5m, 10m, 15m
	object
user required	string Identificador del usuario

Responses

Request samples

Payload

Content type

application/json

{"email": "string",
"expires_in": "string",
"metadata": {"company": "string",
"user_name": "string"
},
"user": "string"
}

Response samples

200
400
500

Content type

application/json

{"result": {"created_at": "string",
"expiration_date": "string",
"reference": "string",
"type": "string",
"user": "string"
},
"success": true
}

Enviar OTP por SMS

Genera y envía un código OTP (One Time Password) de 6 dígitos al número de teléfono especificado.

Características:

Código de 6 dígitos generado aleatoriamente
Tiempo de expiración configurable (formato: 5m, 1h, etc.)
Soporte para códigos de país
Mensajes personalizables con nombre de empresa y usuario
Sistema de respaldo con API key alternativa

Códigos de error:

ERR001: Error de validación en el request
ERR002: Tiempo de expiración inválido o mensaje muy largo (>160 caracteres)
ERR003: Error al crear/enviar el OTP

Authorizations:

ApiKeyAuth

Request Body schema: application/json

Datos para enviar OTP por SMS

country_code	integer Código de país
country_code_included	boolean Incluir código de país en el número de teléfono
expires_in required	string Tiempo de expiración del OTP ejem: 5m, 10m, 15m
	object
phone required	string Número de teléfono
retry	boolean Indica si es un reintento, para usar el numero corto de backup
user required	string Identificador del usuario

Responses

Request samples

Payload

Content type

application/json

{"country_code": 0,
"country_code_included": true,
"expires_in": "string",
"metadata": {"company": "string",
"user_name": "string"
},
"phone": "string",
"retry": true,
"user": "string"
}

Response samples

200
400
500

Content type

application/json

{"result": {"created_at": "string",
"expiration_date": "string",
"reference": "string",
"type": "string",
"user": "string"
},
"success": true
}

Enviar OTP por WhatsApp

Genera y envía un código OTP (One Time Password) de 6 dígitos vía WhatsApp usando plantillas de Meta Business API.

Características:

Código de 6 dígitos generado aleatoriamente
Tiempo de expiración configurable (formato: 5m, 1h, etc.)
Envío mediante WhatsApp Business
Incluye botón con código OTP para facilitar copia

Códigos de error:

ERR001: Error de validación en el request
ERR002: Tiempo de expiración inválido
ERR003: Error al crear/enviar el OTP

Authorizations:

ApiKeyAuth

Request Body schema: application/json

Datos para enviar OTP por WhatsApp

expires_in required	string Tiempo de expiración del OTP ejem: 5m, 10m, 15m
phone required	string Número de teléfono de whatsapp con código de país
user required	string Identificador del usuario

Responses

Request samples

Payload

Content type

application/json

{"expires_in": "string",
"phone": "string",
"user": "string"
}

Response samples

200
400
500

Content type

application/json

{"result": {"created_at": "string",
"expiration_date": "string",
"reference": "string",
"type": "string",
"user": "string"
},
"success": true
}

Validar código OTP

Valida un código OTP previamente generado verificando su autenticidad, vigencia y estado.

Características:

Verificación del código mediante hash SHA256
Validación de expiración temporal
Prevención de reutilización (uso único)
Registro de fecha/hora de validación
Soporte para múltiples tipos: SMS, EMAIL, WHATSAPP

Códigos de error:

ERR001: Error de validación en el request
ERR004: OTP no encontrado (código, usuario o tipo incorrecto)
ERR005: OTP ya fue validado previamente
ERR006: OTP expirado
ERR007: Error al actualizar el registro de validación

Authorizations:

ApiKeyAuth

Request Body schema: application/json

Datos para validar el OTP

code required	string Código de verificación
type required	string Enum: "SMS" "EMAIL" "WHATSAPP" Tipo de OTP
user required	string Identificador del usuario

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"type": "SMS",
"user": "string"
}

Response samples

200
400
404
409
500

Content type

application/json

{"result": {"match": true,
"type": "string",
"user": "string",
"validated_at": "string"
},
"success": true
}