Información General

DevInMotion API Services

Introducción

Bienvenido a la documentación oficial de Devinmotion API Services.

En esta sección se presenta la información correspondiente a los diferentes endpoints expuestos para la gestión de códigos OTP (One-Time Password). Este servicio permite la generación, validación y envío de códigos de verificación mediante los canales disponibles en la plataforma.

La documentación describe de manera estructurada los parámetros requeridos para cada operación, la forma en que deben enviarse las solicitudes (Request) y cómo interpretar las respuestas (Response) del servicio.

Objetivo de esta guía

Proporcionar una referencia técnica clara que facilite la integración con Devinmotion API Services, detallando:

Los ambientes disponibles
Las consideraciones generales de comunicación
La estructura estándar de respuesta del servicio

A lo largo del documento se explican los procesos necesarios para generar y verificar códigos OTP, así como para realizar el envío de los mismos a través de los distintos canales soportados.

Conexión

Para consumir los servicios de DevInMotion API Services se encuentran disponibles los siguientes ambientes:

QA
Ambiente QA
Entorno de pruebas y desarrollo
https://api.devinmotion.dev/v1-0/Operations
PDN
Ambiente Producción (PDN)
Entorno estable para uso en vivo
https://api.devinmotion.net/v1-0/Operations
Importante: Las solicitudes deben realizarse al ambiente correspondiente según la etapa de integración (pruebas o producción).

Estructura del Envelope (Request)

Todas las operaciones se consumen mediante el siguiente envelope estándar:

Estructura JSON del Request 
{
    "Data": {
        "Token": {
            "Id": "[SecurityToken]"
        },
        "Operation": {
            "Version": "[VersionOperation]",
            "Name": "[GroupOperation].[OperationName]",
            "Payload": "[SerializedPayload]"
        }
    }
}
Campo Descripción
Data.Token.Id
Token de seguridad del usuario autenticado
Data.Operation.Version
Versión de la operación (ej. "1.0")
Data.Operation.Name
Nombre calificado de la operación: "[Grupo].[Operacion]" (ej. "OTP.GenerateCodeOperation")
Data.Operation.Payload
Objeto de request serializado como string JSON

Campos base de Response (ResponseBase)

Todos los responses heredan los siguientes campos:

Campo Tipo Descripción
Successful
bool
true si la operación fue exitosa
Message
string
Mensaje informativo o de error del sistema
ErrorCode
string
Código de error (HResult en excepciones)
ExceptionMessage
string
Mensaje de la excepción técnica
UserMessage
string
Mensaje legible para el usuario final

Enums de referencia

NotificationChannel Flags — combinable con OR bitwise

Valor Descripción
Email
Envío por correo electrónico
SMS
Envío por mensaje de texto
WhatsApp
Envío por WhatsApp
All
Envío por todos los canales

OTPType

Valor Descripción
Authentication
Autenticación (valor por defecto)
ActivateAccount
Activación de cuenta
Custom
Tipo personalizado por el usuario

SystemDefType

Valor Descripción
Android
Dispositivo Android
iOS
Dispositivo iOS
Default
Sin tipo específico