Modelo de códigos
Los códigos permiten flujos de verificación de un solo uso, como verificar un usuario o usar una contraseña temporal. Un código es un dato operativo sensible y de corta duración; nunca incluyas un código ni un destinatario real en la documentación o los registros.
Operaciones públicas
La API Reference pública actual contiene estas operaciones de códigos:
| Acción | Método | Recurso | Propósito |
|---|---|---|---|
| Generar un código | POST | /codes/generate | Valida los datos de entrega, crea o reutiliza un código según los límites de solicitudes y lo envía. |
| Verificar un código | GET | /codes/verify | Verifica un código mediante parámetros de consulta. |
| Verificar un código | POST | /codes/verify | Verifica un código mediante un cuerpo de solicitud JSON. |
El contrato público actual de la referencia de la API no documenta GET /codes/generate; su disponibilidad pública no está confirmada.
Consulta los campos, la seguridad y las respuestas de cada operación en la Referencia de API.
Campos del modelo
El modelo contiene estos campos de flujo:
| Campo | Propósito |
|---|---|
id | Identificador numérico de registro. |
sender_id | Usuario que inició el flujo cuando hay uno disponible. |
type | Propósito de verificación. |
channel | Identificador del canal de entrega. |
to | Destinatario normalizado. |
code | Dato de credencial cifrado; nunca lo expongas. |
attemps | Contador de intentos. El nombre contiene un error ortográfico, pero es un campo literal del modelo. |
times | Contador de entregas del registro actual. |
send_data | Datos estructurados de entrega opcionales. |
last_sent_at | Marca de tiempo de la última entrega. |
El modelo de almacenamiento completo no promete que cada campo aparezca en una respuesta pública.
Tipos de código
Si la operación está disponible, valida los tipos del 1 al 5:
| Valor | Significado descrito |
|---|---|
1 | General |
2 | Verificación de celular |
3 | Verificación de correo electrónico |
4 | Contraseña de un solo uso |
5 | Verificación para una acción de eliminación |
Usa únicamente un tipo documentado por la operación que consume el código.
Canales de entrega
Si la operación está disponible, valida los valores de canal del 1 al 8:
| Valor | Comportamiento descrito |
|---|---|
1 | Correo electrónico |
2 | SMS mediante la configuración de Twilio |
3 | Llamada de voz mediante la configuración de Twilio |
4 | WhatsApp mediante la configuración de Twilio |
5–8 | Hooks definidos por plugins; el significado depende de la configuración del proyecto |
La página anterior etiquetaba solo el canal 5 como personalizado. Para canales superiores a 4, el comportamiento descrito usa un hook de plugin específico del canal; no se asignan nombres a los valores 5–8.
La generación de un código no requiere autenticación según el contrato de la operación pública actual, pero sigue sujeta a la configuración del proyecto y a límites de solicitudes. La verificación requiere una clave de API aceptada o una sesión con token de acceso según el contrato público actual. La referencia de la API define estos requisitos de autenticación.
Para el flujo de usuario que consume códigos de verificación, consulta Verificar un usuario.