1. Introducción consumo de API

1.1. Propósito

Este documento establece la definición de los métodos y los valores establecidos como parámetros para el consumo del aplicativo Firma Electrónica API en sistemas externos o aplicaciones clientes.

También se evidencian consideraciones y prerrequisitos necesarios para realizar una integración con otras soluciones.

En este documento se explicara el consumo del controlador “Auth”POST inicialmente, y posteriormente los controladores “Authentication Types” GET.

2. Requisitos Previos para consumo de API

2.1. Autenticación

2.1.1. Autenticación

Por medio de auorización usuario y pasword

2.1.2. Proceso para obtener la API Key o Token de acceso

Debe solicitar usuario y

contraseña

pasword al área IT del operador del servicio el cual suministrará accesos para que pueda consumirlo. 

2.1.3. Seleccione la Versión del consumo

• FS API V1: El consumo de esta versión  no plantea diferencias con su segunda versión.  Haz clic en el enlace Swagger API APP v1 para acceder a la página.

• FS API V2: El consumo de esta versión  no plantea diferencias con su primera versión.   Haz clic en el enlace Swagger API APP v2 para acceder a la página.

2.2. Entorno

 Se manejan dos entornos por marca DEMO y PRODUCCIÓN, con la siguiente estructura:

https://[Personalizable ambiente].[Dominio_cliente].co/

Ejemplo 

DEMO:https://demo.firmaseguro.co/ 

PRODUCCIÓN: https://app.firmaseguro.co/ 

NOTA: Estos entornos pueden personalizarse según la necesidad del cliente.

3. Consumo POST

El objetivo es obtener el token de autorización para el consumo de los microservicios de la API.

Image Added

3.1. Continuación de la URL de Solicitud

Por Favor tenga en cuenta la Versión del Consumo [V1 o V2].

/api/v1/Auth/SignIn

3.2. Parámetros de Solicitud

3.2.1. Método Sign In

Estos son los parámetros solicitados  dentro del método, podrá basarse de los documentado en Swagger

Image Removed

Image Removed

{
  "email": "hola@firmaseguro.co",
  "password": "%AL1h45g6Jw0PChDKKSXRpcFnw"
}

4. Obtener Respuesta del Consumo

Obtendrá la respuesta de la solicitud de inicio de sesión, que incluye el token de autorización y su fecha de vencimiento.

4.1. Parámetros de respuesta

Podrá obtener los siguientes parámetros de respuesta.

Image Modified

Parámetro	Descripción	Ejemplo
token_Type	Descripción del tipo de token	Bearer
acces Token	Key obtenido para el acceso	%AL1h45g6Jw0PChDKhSXRpcFnw1h45g6Jw0PChDKhSXRpcF1h45g6Jw0PChDKhSXRpcF1h45g6Jw0PChDKhSXRpcF1h45g6Jw0PChDKhSXRpcF1h45g6Jw0PChDKhSXRpcF
expires_in	Fecha de expiración del token que se compone de: Fecha: Fecha en formato  aaaa-mm-dd Hora: Hora en formato hh:mm:Z [ Z= Indicador de que la hora está en UTC (Tiempo Universal Coordinado))	2021-11-20T12:47:10Z

4.2. Códigos de respuesta

Igualmente podrá  obtener los siguientes códigos de respuesta:

5. Consideraciones para ejemplificación en Swagger:

• Para autorizar las transacciones  debe usar token el token proporcionado desde el método “SignIn”.  Adicionalmente podrá ejecutar por medio de Swagger el servicio para efectos de ejemplificación, dando click en el botón “Authorize”

Image Added

• Ingrese luego el token. Recuerde que antes de ingresar el token, debes anteponer la palabra 'Bearer' seguida de un espacio para que la autorización sea efectiva.

Image Added

• Una vez hecha la autorización se puede evidenciar como el icono del candado se cierra

Image Removed

Image Removed

Image Modified

6. Límite y uso de cuotas del consumo

•  Actualmente no existe un límite máximo de peticiones

• El Token estará habilitado 30 días calendario

7. Consumos GET

Encontrará también métodos GET donde podrá hacer las siguientes consultas:

7.1. Metodo All

El objetivo del consumo es obtener información sobre todos los tipos de autenticación OTP y tipos de evidencia de firma.

7.1.1. Continuación de la URL de Solicitud

Por favor tenga en cuenta la Versión 1 del Consumo  [Swagger API APP v1] .
api/v1/AutenticationTypes/All

7.1.2. Parámetros:

No requiere parámetros para su ejecución

7.1.3. Obtener Response:

Obtendrá la respuesta de  los tipos de autenticación OTP y tipos de evidencia de firma.

• OTP Call: Autenticación OTP vía llamada telefónica.

• OTP SMS: Autenticación OTP vía mensaje de texto.

• OTP Email: Autenticación OTP vía correo electrónico.

• OTP Whatsapp: Autenticación OTP vía WhatssApp.

• Manuscrita: Evidencia  de Firma manuscrita

• Fotográfica:  Evidencia  de Firma fotográfica

Image Modified

Igualmente podrá  obtener los siguientes códigos de respuesta:

7.2. Metodo Get-all-authentications-methods

El objetivo del consumo es obtener información sobre todos los tipos de autenticación OTP .

Continuación de la URL de Solicitud

Por favor tenga en cuenta la Versión 1 del Consumo  [Swagger API APP v1] .
api/v1/AutenticationTypes/Get-all-authentications-methods

Parámetros:

No requiere parámetros para su ejecución

Obtener Response:

Obtendrá la respuesta de  los tipos de autenticación OTP.

OTP Call: Autenticación OTP vía llamada telefónica.

OTP SMS: Autenticación OTP vía mensaje de texto.

OTP Email: Autenticación OTP vía correo electrónico.

OTP Whatsapp: Autenticación OTP vía WhatssApp.

Image Modified

• Igualmente podrá  obtener los siguientes códigos de respuesta:

3. Metodo Get-all-evidence-methods

El objetivo del consumo es obtener información sobre todos los tipos de evidencia de firma.

1. Continuación de la URL de Solicitud: Por favor tenga en cuenta la Versión 1 del Consumo  [Swagger API APP v1] .
   api/v1/AutenticationTypes/Get-all-evidence-methods

2. Parámetros:
   No requiere parámetros para su ejecución

3. Obtener Response:

4. Obtendrá la respuesta de  los tipos de evidencia de firma.

   • Manuscrita: Evidencia  de Firma manuscrita

   • Fotográfica:  Evidencia  de Firma fotográfica

Image Modified

• Igualmente podrá  obtener los siguientes códigos de respuesta:

4. Método AutenticationTypesById (Por Id)

El objetivo del consumo es obtener información sobre todos los tipos de autenticación OTP y tipos de evidencia de firma, consultando por medio de su ID.

1. Continuación de la URL de Solicitud: Por favor tenga en cuenta la Versión 1 del Consumo  [Swagger API APP v1] .
   api/v1/AutenticationTypes/All

2. Parámetros:
   Requiere el Id  a consultar en el mismo header
   

Image Modified

1. ID_1_OTP Call: Autenticación OTP vía llamada telefónica.

2. ID_2_OTP SMS: Autenticación OTP vía mensaje de texto.

3. ID_3_OTP Email: Autenticación OTP vía correo electrónico.

4. ID_4_OTP Whatsapp: Autenticación OTP vía WhatssApp.

5. ID_5_Manuscrita: Evidencia  de Firma manuscrita

6. ID_6_Fotográfica:  Evidencia  de Firma fotográfica

7. Obtener Response:

8. Obtendrá la respuesta de  los tipos de autenticación OTP y tipos de evidencia de firma.

Image Modified

• Igualmente podrá  obtener los siguientes códigos de respuesta:

8. Soporte:
   En caso de requerir ayuda adicional por favor comunicarse  con el área de Soporte por medio de estos canales:

Image Modified

Image Modified

• Canal de WhatsApp: +57 321 6795099, donde deberá seguir las instrucciones para identificarse y ser atendido. 

• Hub Spot: Botón con forma de burbuja de diálogo ubicado en la esquina inferior derecha cuando se ingresa  al ala plicacio con un usuario administrativo y operativo.

  Abrirá un chat que te permitirá solventar tus dudas con un Agente de soporte.