PSC: Pruebas Postman

POST – 01 nuevo documento – obtener URL – AT21

https://restapi.firmar.online//PSC/v40/DocumentSet/Url

Sube un documento al notario electrónico y recupera una URL para su visualización y firma. Este método devuelve una URL donde se podrá visualizar el documento a firmar, así como el identificador del documento. Así se permite integrar la firma electronica en flujos de trabajo, de forma transparente para el usuario.

El ActionType 20 muestra el documento y solicita la aceptación. El documento aceptado no se modifica. No se tiene que informar el widget (si viene informado, no se atiende). El ActionType 21 muestra el documento y solicita la aceptación. El documento aceptado se firma electronicamente.


AUTHORIZATION         API Key

Key                                   <key>
Value                                CONSULTAR


 

BODY Raw

{
"documentSetName": "Documento URL - firmar.online - con fecha ISO {{$isoTimestamp}} ",
"sendermail": "noresponda@firmar.online",
"Sendername": "Nombre del emisor - firmar.online",
"expirationDaysTimeout": 1,
"recipient":
{
"name": "PRE primer interviniente",
"email": "noresponda@firmar.online",
"cardId": "PRE_primer_34587624",
"phoneNumber": "+34612345678",
"actionType": 21,
"widget" :
{ "customtext" :
[
{ "text": "Documento firmado digitalmente", "fontSize": 3 } ,
{ "text": "Interviene: {{RecipientName}}", "fontSize": 3 } ,
{ "text": "Fecha ISO: ##TIMESTAMP##", "fontSize": 2 }
],
"page": 99, "x": 50, "y": 10,
"width" : 100, "height" : 50
}
},

“document”:
{
“name”: “Documento de {{RecipientName}} con fecha {{$isoTimestamp}}”,
“b64PDFContent”:{{DocPDF}}
}

}

POST 01 nuevo documento – obtener URL – AT30 – posicionamiento fijo

https://restapi.firmar.online//PSC/v40/DocumentSet/Url

Sube un documento al notario electrónico y recupera una URL para su visualización y firma. Este método devuelve una URL donde se podrá visualizar el documento a firmar, así como el identificador del documento. Así se permite integrar la firma electronica en flujos de trabajo, de forma transparente para el usuario.

El ActionType 20 muestra el documento y solicita la aceptación. El documento aceptado no se modifica. No se tiene que informar el widget (si viene informado, no se atiende). El ActionType 21 muestra el documento y solicita la aceptación. El documento aceptado se firma electronicamente.


AUTHORIZATION         API Key

Key                                   
Value                                CONSULTAR


 

BODY Raw

{
"documentSetName": "Documento URL - firmar.online - con fecha ISO {{$isoTimestamp}} ",
"sendermail": "noresponda@firmar.online",
"Sendername": "Nombre del emisor - firmar.online",
"expirationDaysTimeout": 1,
"recipient":
{
"name": "PRE primer interviniente",
"email": "noresponda@firmar.online",
"cardId": "PRE_primer_34587624",
"phoneNumber": "+34612345678",
"actionType": 30,
"widget" :
{ "customtext" :
[
{ "text": "Documento firmado digitalmente", "fontSize": 3 } ,
{ "text": "Interviene: {{RecipientName}}", "fontSize": 3 } ,
{ "text": "Fecha ISO: ##TIMESTAMP##", "fontSize": 2 }
],
"page": 99, "x": 50, "y": 10,
"width" : 100, "height" : 50
}
},
"document":
{
"name": "Documento de {{RecipientName}} con fecha {{$isoTimestamp}}",
"b64PDFContent":{{DocPDF}}
}
}

POST 01 nuevo documento – obtener URL – AT30 – posicionamiento flotante del widget

https://restapi.firmar.online//PSC/v40/DocumentSet/Url

Sube un documento al notario electrónico y recupera una URL para su visualización y firma. Este método devuelve una URL donde se podrá visualizar el documento a firmar, así como el identificador del documento. Así se permite integrar la firma electronica en flujos de trabajo, de forma transparente para el usuario.

El ActionType 20 muestra el documento y solicita la aceptación. El documento aceptado no se modifica. No se tiene que informar el widget (si viene informado, no se atiende). El ActionType 21 muestra el documento y solicita la aceptación. El documento aceptado se firma electronicamente.


AUTHORIZATION         API Key

Key                                   
Value                                CONSULTAR


 

BODY Raw

{
"documentSetName": "Documento URL - firmar.online - con fecha ISO {{$isoTimestamp}} ",
"sendermail": "noresponda@firmar.online",
"Sendername": "Nombre del emisor - firmar.online",
"expirationDaysTimeout": 1,
"recipient":
{
"name": "PRE primer interviniente",
"email": "noresponda@firmar.online",
"cardId": "PRE_primer_34587624",
"phoneNumber": "+34612345678",
"actionType": 30,
"widget" :
{ "customtext" :
[
{ "text": "Documento firmado digitalmente", "fontSize": 3 } ,
{ "text": "Interviene: {{RecipientName}}", "fontSize": 3 } ,
{ "text": "Fecha ISO: ##TIMESTAMP##", "fontSize": 2 }
],
"text": "https://", "gapX": 30, "gapY": 30,
"width" : 100, "height" : 50
}
},
"document":
{
"name": "Documento de {{RecipientName}} con fecha {{$isoTimestamp}}",
"b64PDFContent":{{DocPDF}}
}
}

POST 01 nuevo documento – obtener URL – AT30 – posicionamiento en campo de firma

https://restapi.firmar.online//PSC/v40/DocumentSet/Url

Sube un documento al notario electrónico y recupera una URL para su visualización y firma. Este método devuelve una URL donde se podrá visualizar el documento a firmar, así como el identificador del documento. Así se permite integrar la firma electrónica en flujos de trabajo, de forma transparente para el usuario.

El ActionType 20 muestra el documento y solicita la aceptación. El documento aceptado no se modifica. No se tiene que informar el widget (si viene informado, no se atiende). El ActionType 21 muestra el documento y solicita la aceptación. El documento aceptado se firma electrónicamente.


AUTHORIZATION         API Key

Key                                   
Value                                CONSULTAR


 

BODY Raw

{
"documentSetName": "Documento URL - firmar.online - con fecha ISO {{$isoTimestamp}} ",
"sendermail": "noresponda@firmar.online",
"Sendername": "Nombre del emisor - firmar.online",
"expirationDaysTimeout": 1,
"recipient":
{
"name": "PRE primer interviniente",
"email": "noresponda@firmar.online",
"cardId": "PRE_primer_34587624",
"phoneNumber": "+34612345678",
"actionType": 30,
"widget" :
{ "customtext" :
[
{ "text": "Documento firmado digitalmente", "fontSize": 3 } ,
{ "text": "Interviene: {{RecipientName}}", "fontSize": 3 } ,
{ "text": "Fecha ISO: ##TIMESTAMP##", "fontSize": 2 }
],
"fieldName": "FirmaVendedor"
}
},
"document":
{
"name": "Documento de {{RecipientName}} con fecha {{$isoTimestamp}}",
"b64PDFContent":{{DocPDF_fields}}
}
}

POST 10 nuevo documento – envio simple – eMail – AT30

https://restapi.firmar.online//PSC/v40/DocumentSet/simple

Envio de un documento a un firmante por mail. El interesado recibe un mail con el link al documento. Pulsando este link lo visualiza y lo firma.


AUTHORIZATION         API Key

Key                                   
Value                                CONSULTAR


 

 

BODY Raw

{
"documentSetName": "Documento URL - firmar.online - con fecha ISO {{$isoTimestamp}} ",
"sendermail": "noresponda@firmar.online",
"Sendername": "Nombre del emisor - firmar.online",
"expirationDaysTimeout": 3,
"reminderDays": 1,
"sendMethod": 1,
"recipient":
{
"name": "PRE primer interviniente",
"email": "noresponda@firmar.online",
"cardId": "PRE_primer_34587624",
"phoneNumber": "+34612345678",
"actionType": 30,
"widget" :
{ "customtext" :
[
{ "text": "Documento firmado digitalmente", "fontSize": 3 } ,
{ "text": "Interviene: {{RecipientName}}", "fontSize": 3 } ,
{ "text": "Fecha ISO: ##TIMESTAMP##", "fontSize": 2 }
],
"text": "https://", "gapX": 30, "gapY": 30,
"width" : 100, "height" : 50
}
},
"document":
{
"name": "Documento de {{RecipientName}} con fecha {{$isoTimestamp}}",
"b64PDFContent":{{DocPDF}}
}
}

POST 10 nuevo documento – envio simple – SMS – AT30

https://restapi.firmar.online//PSC/v40/DocumentSet/simple

Envio de un documento a un firmante por mail. El interesado recibe un mail con el link al documento. Pulsando este link lo visualiza y lo firma.


AUTHORIZATION         API Key

Key                                   
Value                                CONSULTAR


 

 

BODY Raw

{
"documentSetName": "Documento URL - firmar.online - con fecha ISO {{$isoTimestamp}} ",
"sendermail": "noresponda@firmar.online",
"Sendername": "Nombre del emisor - firmar.online",
"expirationDaysTimeout": 3,
"sendMethod": 2,
"recipient":
{
"name": "PRE primer interviniente",
"email": "noresponda@firmar.online",
"cardId": "PRE_primer_34587624",
"phoneNumber": "+34612345678",
"actionType": 30,
"widget" :
{ "customtext" :
[
{ "text": "Documento firmado digitalmente", "fontSize": 3 } ,
{ "text": "Interviene: {{RecipientName}}", "fontSize": 3 } ,
{ "text": "Fecha ISO: ##TIMESTAMP##", "fontSize": 2 }
],
"text": "https://", "gapX": 30, "gapY": 30,
"width" : 100, "height" : 50
}
},
"document":
{
"name": "Documento de {{RecipientName}} con fecha {{$isoTimestamp}}",
"b64PDFContent":{{DocPDF}}
}
}

POST 20_ nuevo documento – eMail – UN documento VARIOS firmantes

https://restapi.firmar.online//PSC/v40/DocumentSet/

Método general de envío de documentos. En el ejemplo se muestra el envío de un documento: primero lo acepta un “validador”, luego se envía a un firmante y por último se envía copia del documento a un tercer interviniente.


AUTHORIZATION         API Key

Key                                   
Value                                CONSULTAR


 

 

BODY Raw

{
"documentSetName": "Documento Multifirma - firmar.online - con fecha ISO {{$isoTimestamp}} ",
"sendermail": "noresponda@firmar.online",
"Sendername": "Nombre del emisor - firmar.online",
"expirationDaysTimeout": 3,
"reminderDays": 1,
"sendMethod": 1,
"recipients":
[
{
"id": "34101266", "name": "PRE primer interviniente", "email": "noresponda@firmar.online", "cardId": "PRE_primer_34587624", "phoneNumber": "+34612345678",
"actionType": 20,
"widgets":
[ {
"documentId": "Documento_id_001",
"widget" :
{ "customtext" :
[
{ "text": "Documento firmado digitalmente", "fontSize": 3 } ,
{ "text": "Interviene: {{RecipientName}}", "fontSize": 3 } ,
{ "text": "Fecha ISO: ##TIMESTAMP##", "fontSize": 2 }
],
"text": "https://", "gapX": 30, "gapY": 30,
"width" : 100, "height" : 50
}
} ]
},
{
"id": "34101266B", "name": "PRE Segundo Interviniente", "email": "noresponda@firmar.online", "cardId": "PRE_seg_34587624", "phoneNumber": "+34612345678",
"actionType": 30,
"widgets":
[ {
"documentId": "Documento_id_001",
"widget" :
{ "customtext" :
[
{ "text": "Documento firmado digitalmente", "fontSize": 3 } ,
{ "text": "Interviene: {{RecipientName}}", "fontSize": 3 } ,
{ "text": "Fecha ISO: ##TIMESTAMP##", "fontSize": 2 }
],
"page": 99, "x": 50, "y": 10,
"width" : 100, "height" : 50
}
} ]
},
{
"id": "34101266c", "name": "PRE Tercer Interviniente", "email": "noresponda@firmar.online", "cardId": "PRE_tercer_4587624", "phoneNumber": "+34617323455",
"actionType": 10,
"widgets":
[ {
"documentId": "Documento_id_001",
"widget" :
{ "customtext" :
[
{ "text": "Documento firmado digitalmente", "fontSize": 3 } ,
{ "text": "Interviene: {{RecipientName}}", "fontSize": 3 } ,
{ "text": "Fecha ISO: ##TIMESTAMP##", "fontSize": 2 }
],
"page": 99, "x": 50, "y": 10,
"width" : 100, "height" : 50
}
} ]
}
],
"documents":
[
{
"id": "Documento_id_001",
"name": "Documento Multifirma",
"b64PDFContent":{{DocPDF}}
}
]
}

GET 100_ Certificado de trazabilidad

https://restapi.firmar.online//PSC/v40/DocumentSet/Document/{{DocumentSet_id}}/1

Permite obtener el documento una vez firmado.


AUTHORIZATION         API Key

Key                                   <key>
Value                                CONSULTAR


 

GET 100_ Documento firmado

https://restapi.firmar.online//PSC/v40/DocumentSet/Evidences/{{DocumentSet_id}}

Permite obtener el certificado de trazabilizad en formato PDF. Input: identificador del documento a firmar. Output: certificado de trazabilizad en formato PDF

 


AUTHORIZATION         API Key

Key                                   <key>
Value                                CONSULTAR


 

GET 100_ Estado del documento

https://restapi.firmar.online//PSC/v40/DocumentSet/Status/{{DocumentSet_id}}

Recupera el estado del documento


AUTHORIZATION         API Key

Key                                   <key>
Value                                CONSULTAR


 

GET 100_ Detalle – cabeceras del documento

https://restapi.firmar.online//PSC/v40/DocumentSet/{{DocumentSet_id}}

Recupera el estado del documento


AUTHORIZATION         API Key

Key                                   <key>
Value                                CONSULTAR


 

GET 100_ AuditTrial del proceso

https://restapi.firmar.online//PSC/v40/DocumentSet/AuditTrail/{{DocumentSet_id}}

Recupera los datos básicos del documento


AUTHORIZATION         API Key

Key                                   <key>
Value                                CONSULTAR


 

GET 100_ Errores del documento

https://restapi.firmar.online//PSC/v40/DocumentSet/error/{{DocumentSet_id}}

Recupera el estado del documento


AUTHORIZATION         API Key

Key                                   <key>
Value                                CONSULTAR


 

PUT 300_ Cancelar proceso

https://restapi.firmar.online//PSC/v40/DocumentSet/Cancel/{{DocumentSet_id}}

CANCELA el flujo de firma. El documento deja de estar disponible para los intervinientes.


AUTHORIZATION         API Key

Key                                  <key>
Value                              CONSULTAR


 

PUT 300_ volver a enviar documento por mail

https://restapi.firmar.online//PSC/v40/DocumentSet/Resend/{{DocumentSet_id}}

Envia por mail el recordatorio notificando al interesado que el documento sigue pendiente de firma.

 


AUTHORIZATION         API Key

Key                                  <key>
Value                              CONSULTAR


 


GET 400_ History

https://restapi.firmar.online//PSC/v40/History?Limit=10

Permite obtener el certificado de trazabilizad en formato PDF. Input: identificador del documento a firmar. Output: certificado de trazabilizad en formato PDF


AUTHORIZATION         API Key

Key                                  <key>
Value                              CONSULTAR


PARAMS

Limit                                  10