Obtener documentos

Permite obtener un listado paginado de los documentos

GET https://api.enviafirma.com/documentos?estado=firmado&page=1$limit=20

Headers

Name	Type	Description
X-Auth-Token*	string	API Key

Query Params

Nombre	Descripción
estado	Es un parámetro opcional en el que se puede especificar el estado de los documentos a obtener. Los estados pueden ser: pendiente: Pendiente de firma por 1 o varios firmantes. firmado: Documento firmado rechazado: Si uno o varios firmantes rechazaron el proceso de firma cancelado: Si el proceso de firma fue cancelado Si no se para este parámetro, se retornan los documentos de todos los estados.
page	Indica la página actual de resultados que se solicita
limit	Especifica cuántos elementos/registros se deben devolver por página

Ejemplo de petición

const myHeaders = new Headers();
myHeaders.append("X-Auth-Token", "10301c9c-2d09-43c3-950a-XXXXXXXXX");

const requestOptions = {
  method: "GET",
  headers: myHeaders,
};

fetch("https://api.enviafirma.com/documentos/estado?estado=firmado&page=1&limit=20", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

Respuesta - 200

Ejemplo:

{
  "data": [
      {
         "id": "7a6e8f5c-4415-4cc9-a0fe-03db889e1607",
         "fechaCreado": "2024-10-22T16:24:22.000Z",
         "fechaCompletado": null,
         "fechaCancelado": null,
         "estado": "pendiente",
         "hash": "4aab935c-bbb0-4017-ae40-e972c3b367de",
         "nombreDocumento": "Datos del certificado",
         "rutaDocumentoOriginal": "https://firebasestorage.googleapis.com/v0/b/enviafirma/o/12F1018535.pdf",
         "rutaDocumentoFirmado": "https://firebasestorage.googleapis.com/v0/b/enviafirma/o/12F1018535f.pdf",
         "metodoNotificacion": "whatsapp",
         "hashSha256": "fd984bad363e9a30021460091726467b65bb1e88c31752d93c68ade87e4946e4",
         "idiomaNotificaciones": "es",
         "firmantes": [
                        {
                          "nombre": "Jose Orozco",
                          "indicativoCelular": "+57",
                          "numeroCelular": "3013224455",
                          "estado": "firmado",
                          "hash": "b610ee6f-2e01-4429-9711-dd0f93f208ab",
                          "fechaCreado": "2024-10-22T16:24:22.000Z",
                          "fechaFirmado": "2024-10-23T16:24:22.000Z",
                          "fechaRechazado": null   
                        },
                        {
                          "nombre": "Bernardo Morales",
                          "indicativoCelular": "+34",
                          "numeroCelular": "6723224455",
                          "estado": "pendiente",
                          "hash": "b2c3f640-a92d-4aa0-bba4-7be43f70dc0d",
                          "fechaCreado": "2024-10-22T16:24:22.000Z",
                          "fechaFirmado": "2024-10-23T16:24:22.000Z",
                          "fechaRechazado": null    
                        }
                      ]
       },
       {
         "id": "236e8f5c-4415-4cc9-a0fe-03db889e1607",
         "fechaCreado": "2024-09-18T16:24:22.000Z",
         "fechaCompletado": "2024-09-19T16:27:39.000Z",
         "fechaCancelado": null,
         "estado": "firmado",
         "hash": "9hab935c-bbb0-4017-ae40-e972c3b367de",
         "nombreDocumento": "Datos del certificado",
         "rutaDocumentoOriginal": "https://firebasestorage.googleapis.com/v0/b/enviafirma/o/12F1018535.pdf",
         "rutaDocumentoFirmado": "https://firebasestorage.googleapis.com/v0/b/enviafirma/o/12F1018535f.pdf",
         "metodoNotificacion": "email",
         "hashSha256": "fd984bad363e9a30021460091726467b65bb1e88c31752d93c68ade87e4946e4",
         "idiomaNotificaciones": "es",
         "firmantes": [
                      {
                        "nombre": "Carolina Ortega",
                        "indicativoCelular": null,
                        "numeroCelular": null,
                        "email": "[email protected]
                        "estado": "firmado"  
                      },
                      {
                        "nombre": "Jose Orozco",
                        "indicativoCelular": null,
                        "numeroCelular": null,
                        "email": "[email protected]",
                        "estado": "firmado"   
                      },
                    ]
       }
  ],
  "meta": {
      "total": 210,
      "page": 1,
      "limit": 20,
      "totalPages": 11
  }
}