2FA REST API

Resumen

Esta página describe los recursos que conforman 2FA REST API v1, para desarrolladores que desean integrar la autenticación de dos factores en su aplicación.

El API REST 2FA proporciona acceso a los recursos (entidades de datos) a través de rutas URI. Para usar una API REST, su aplicación realizará una solicitud HTTP y analizará la respuesta. El formato de respuesta es JSON. Su método será el método HTTP estándar POST.

Autenticación

La autenticación básica HTTP se utiliza para todas las solicitudes. Si accede a la API sin tener las credenciales correctas O permiso para acceder a la API, obtendrá una respuesta HTTP 401.

Le proporcionaremos un nombre de usuario y contraseña para usar. El nombre de usuario de su aplicación es el mismo que el nombre de su aplicación en OMNI. Si no tiene estos detalles, comuníquese con support@modicagroup.com.

URI Base

Todo el acceso a la API es a través de HTTPS, y se accede desde: https://api.modicagroup.com/rest/2fa

Versiones

La versión de la API REST es actualmente v1. Se utiliza un tipo de medio personalizado para que los consumidores elijan el formato de datos que desean recibir:

Accept: application/vnd.modica.2fa.v1+json

Creando una solicitud

Para enviar una solicitud a un teléfono móvil, envíe una solicitud POST:

POST /challenges

{
 "destination": str:mobile-number
}

infoEl formato del número de móvil debe ser formato internacional, por ejemplo. +18091234567

Para agregar un mensaje personalizado, simplemente agregue el atributo de contenido opcional::

{
 "content": "Your 2FA code is: %(code)s"
}

warningSi la variable de contenido está establecida, debe incluir la variable con el nombre %(code)s, de lo contrario se devuelve un error HTTP 400

Para enmascarar el número a un string personalizado, agregue el atributo opcional ‘mask’:

{
 "mask": "ModGrpExmpl"
}

infoEl enmascaramiento no está disponible para todos los países y operadores de telefonía móvil

infoLa longitud máxima de la máscara es de 11 caracteres. Las máscaras que excedan esta longitud serán rechazadas por los operadores de telefonía móvil.

Cuando se envía correctamente:

HTTP/1.1 201 Created

X-Modica-Request-Id: uuid:request-id
{
 "created": str:timestamp,
 "expires": str:timestamp,
 "id": uuid:challenge-id
}

infoLa hora está en el estándar UTC

Cuando existe un error de validación:

HTTP/1.1 400 Bad Request

X-Modica-Request-Id: uuid:request-id
{
 "error": str:error-code
}

Respuesta de Solicitud

Para validar una respuesta a una solicitud enviada envíe una solicitud POST:

POST /responses

{
 "challenge_id": uuid:challenge-id,
 "code": str:challenge-code
}

Cuando se envía correctamente:

HTTP/1.1 201 Created
X-Modica-Request-Id: uuid:request-id

{
 "status": str:status-code
}

Cuando existe un error de validación:

HTTP/1.1 400 Bad Request
X-Modica-Request-Id: uuid:request-id

{
 "error": str:error-code
}

Ayuda

¿Tienes problemas para integrarte con alguno de nuestros servicios? Visite nuestro servicio de asistencia técnica en https://omni.modicagroup.com/docs/es/ o póngase en contacto con support@modicagroup.com y le ayudaremos a resolverlo.