efirma.com

Appearance

Expedientes ​

Agrupe documentos similares en expedientes.

Lista de Expedientes ​

Nos permitirá obtener la lista de todos los expedientes creados.

http
GET /api/files

Request ​

bash
curl -X GET -H "X-eFirma-Auth: {"uid":"UID_EFIRMA","key":"KEY_EFIRMA"}" "https://efirma.com/api/files"

Response ​

json
[
    {
        "id": "63d025xxxxcdb32xxxxxx",
        "name": "EXPEDIENTE_PRUEBA",
        "conteo": 12,
        "documents": [
            {
                "id": "63d025xxxxcdb32xxxxxx",
                "name": "hello-world.pdf",
                "createdat": "0001-01-01T00:00:00Z",
                "expirydate": "0001-01-01T00:00:00Z",
                "hash": "66c0fc2bb90ce3565c4cb8a8afdf3bd800323c94d7d3003971cdd7c186985159",
                "fully_signed": true,
                "original_file": "",
                "evidence_file": "",
                "merged_file": "",
                "signed_file": "",
                "pages": 1
            }

        ]
    },
    {
        "id": "63d025xxxxcdb32xxxxxx",
        "name": "Expediente de Prueba",
        "conteo": 27,
        "documents": [
            {
                "id": "63d025xxxxcdb32xxxxxx",
                "name": "hello-world.pdf",
                "createdat": "0001-01-01T00:00:00Z",
                "expirydate": "0001-01-01T00:00:00Z",
                "hash": "66c0fc2bb90ce3565c4cb8a8afdf3bd800323c94d7d3003971cdd7c186985159",
                "fully_signed": false,
                "original_file": "",
                "pages": 1
            }
        ]
    }
]

Buscar Expediente ​

Nos permitirá obtener la información de un expediente.

http
GET /api/files/:id

Request ​

bash
curl -X GET -H "X-eFirma-Auth: {"uid":"UID_EFIRMA","key":"KEY_EFIRMA"}" "https://efirma.com/api/files/:id"

Response ​

json
{
    "id": "63d025xxxxcdb32xxxxxx",
    "name": "EXPEDIENTE_PRUEBA",
    "conteo": 12,
    "documents": [
        {
            "id": "63d025xxxxcdb32xxxxxx",
            "name": "hello-world.pdf",
            "createdat": "0001-01-01T00:00:00Z",
            "expirydate": "0001-01-01T00:00:00Z",
            "hash": "66c0fc2bb90ce3565c4cb8a8afdf3bd800323c94d7d3003971cdd7c186985159",
            "fully_signed": true,
            "original_file": "",
            "evidence_file": "",
            "merged_file": "",
            "signed_file": "",
            "pages": 1
        }
    ]
}

Crear Expediente ​

Permite crear un expediente llenándolo con documentos existentes. En el BODY enviaremos un arreglo de IDs de documentos. Se puede crear un expediente sin documentos enviando el BODY vacío.

http
POST /api/file/:nombre

Request ​

bash
curl -X POST \
  -H "Content-Type: application/json" \
  -H "Accept-Encoding: application/json" \
  -H "X-eFirma-Auth: {"uid":"SU_USER_ID","key":"SU_API_KEY"}" \
  -d '["idDocumento1","idDocumento2","idDocumento3"]' \
  "https://efirma.com/api/file/:nombre"

Response ​

json
{
    "id": "5e41dd35aa4xxxxx10db52f7"
}

Agregar Documentos a Expediente ​

INFO

Permite agregar documentos a un expediente existente.

http
PUT /api/file/:nombre

Request ​

bash
curl -X PUT \
  -H "Content-Type: application/json" \
  -H "Accept-Encoding: application/json" \
  -H "X-eFirma-Auth: {"uid":"SU_USER_ID","key":"SU_API_KEY"}" \
  -d '["idDocumento1","idDocumento2","idDocumento3"]' \
  "https://efirma.com/api/file/:nombre"

Response ​

json
{
    "id": "5e41dd35aa4xxxxx10db52f7"
}