Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

VERSIONAMIENTO DEL DOCUMENTO

...

DOCUMENTACIÓN SERVICIO WEB FIRMA SEGUROELECTRÓNICA

 

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

...

Es una de las estrategias propuesta por Firma Seguro electrónica API para consultar el estado de un proceso periódicamente y si el proceso está terminado exitosamente retorna el documento pdf firmado en base 64.

...

Es una de las estrategias propuestas por Firma Seguro electrónica API para devolver el documento pdf firmado en base 64, en este caso es necesario que el sistema cliente implemente un end point al cual Firma Seguro electrónica API responderá cuando el proceso esté terminado exitosamente.

...

Diagrama de secuencia “Creación de proceso”

 

2.1 Ir al link a la página API Kiai URL de la API suministrada

2.2 Ir a la sección Auth

...

2.3 Ingresar el request /Sign In

{                                     

  "email": "csandoval@tredasolutions.com",      

  "password": "%AL1h45g6Jw0PChDKKSXRpcFnw"

...

2.8 Ejecutar el request ProcessCreateFull: Ejemplos

 

Tipo de proceso “Solo yo”: Único firmante

{

    "processTypeId": 1,

    "signatureMethodId": 2,

...

          "phoneId": 0,

          "email": "jhon.doe@email.com",

          "personId": 0,

...

    "messageEmail": "primera firma desde la api firmasegurofirmaelectrónica",

    "copyEmails": "juan.perez@email.com, nina.tul@email.com"

  }

 

Nota: Recordar que la persona que firma en el tipo de proceso “Solo yo” debe ser la misma que está autenticada en la api.

 

Tipo de proceso “Otros y yo”: Mínimo 2 firmantes, máximo 10

{

    "processTypeId": 2,

    "signatureMethodId": 1,

...

          "phoneId": 0,

          "email": "jhon.doe@email.com",

          "personId": 0,

...

          "phoneId": 0,

          "email": "juan.perez@email.com",

          "personId": 0,

...

    "messageEmail": "primera firma desde la api firmasegurofirmaelectrónica",

    "copyEmails": ""

  }

Nota: Recordar que las personas que firman en el tipo de proceso “Otros y yo” debe ser la misma que está autenticada en la api, quien hace el papel del YO y otras personas ajenas.

 

Tipo de proceso “Solo Otros”: Mínimo 1 firmante, máximo 10

{

    "processTypeId": 3,

    "signatureMethodId": 2,

...

          "phoneId": 0,

          "email": "jhon.doe@email.com",

          "personId": 0,

...

    "messageEmail": "primera firma desde la api firmasegurofirmaelectronica",

    "copyEmails": "juan.perez@email.com, nina.tul@email.com"

  }

Nota: Recordar que las personas que firman en el tipo de proceso “Solo otros” son otras personas ajenas a quien se encuentra autenticado.

...

curl --location --request GET 'https://demo.firmaseguro.co{dominio-api-entorno}/api/v1/Document/ByUUID/uuid' \

--header 'Authorization: Bearer Token'

...

    "document":"Base64String"

}

 

Más información dirigirse a los procesos detallados en la wiki de firma seguro.

 

                           Response Sign I

...

          "phoneId": 0,

          "email": "jhon.doe@email.com",

          "personId": 0,

...

    "messageEmail": "primera firma desde la api firmasegurofirmaelectrónica",

    "copyEmails": "juan.perez@email.com, nina.tul@email.com"

  }

 

 

Nota: Recordar que la persona que firma en el tipo de proceso “Solo yo” debe ser la misma que está autenticada en la api, y con tipo de saldo por documentos - Email (Todos los firmantes deben de tener el mismo método de autenticación, en este caso de ejemplo, es el Email).

...

          "phoneId": 0,

          "email": "jhon.doe@email.com",

          "personId": 0,

...

          "phoneId": 0,

          "email": "juan.perez@email.com",

          "personId": 0,

...

    "messageEmail": "primera firma desde la api firmasegurofirmaelectrónica",

    "copyEmails": ""

  }

...

          "phoneId": 0,

          "email": "jhon.doe@email.com",

          "personId": 0,

...

    "messageEmail": "primera firma desde la api firmasegurofirmaelectrónica",

    "copyEmails": "juan.perez@email.com, nina.tul@email.com"

  }

Nota: Recordar que las personas que firman en el tipo de proceso “Solo otros” son otras personas ajenas a quien se encuentra autenticado, con tipo de saldo por documentos - SMS (Todos los firmantes deben de tener el mismo método de autenticación, en este caso SMS).

...