Documentación de API para certificación de documentos

Úiltima actualización el 03 de septiembre, 2019.


¡Bienvenido a LifeChain! aquí encontraras la documentación necesaria para certificar y validar tus documentos vía API, así como consultar tus créditos disponibles para certificar nuevos documentos.

Nota:

  • Cada certificación de documento por individual consume un crédito. El número de créditos disponibles depende del tipo de plan que tengas contratado para LifeChain Documentos. No nos hacemos responsables por el mal uso o uso irresponsable de los créditos una vez asignados a su usuario u organización.

Consultar créditos disponibles

Con ayuda de esta petición podrás consultar tus créditos disponibles. Cada crédito sirve para certificar un documento dentro de LifeChain.

  • Endpoint: https://api.lifechain.mx/documentos/creditos/
  • Verbo HTTP: GET
  • Ejemplo de petición:

curl -X 'GET' 'https://api.lifechain.mx/documentos/creditos/' \
-H 'api_key: G8Jx0p0iYS.KpZYXHqChmEG58Lg9KpCD1O9CN0SY7oUrnmHQB5CYmXhbjO0GtirV'
				
  • Ejemplo de respuesta exitosa:

{"creditos": 5}
				

Certificar un documento

Para certificar un documento es necesario mandar en el cuerpo de la petición el contenido del documento a certificar codificado en base64, asignándole el nombre “contenido”; además del nombre con el que se desea guardar el archivo (incluyendo el formato del mismo).

  • Endpoint: https://api.lifechain.mx/documentos/api-key/
  • Endpoint de prueba (no consume créditos): https://api.lifechain.mx/documentos/api-key-test/
  • Verbo HTTP: POST
  • Ejemplo de petición:

curl -X 'POST' 'https://api.lifechain.mx/documentos/api-key/' \
-H 'api_key: G8Jx0p0iYS.KpZYXHqChmEG58Lg9KpCD1O9CN0SY7oUrnmHQB5CYmXhbjO0GtirV' \
-d 'nombre=prueba.txt&contenido=SG9sYSBtdW5kbyEgc29tb3MgTGlmZUNoYWluIQo='
				
  • Ejemplo de respuesta exitosa:

{
    "txHashConfirmed": true,
    "_id": "5d6f2667e3e98401c24baa59",
    "fecha_certificacion": "2019-09-04T02:50:15.579Z",
    "nombre": "prueba.pdf",
    "fileHash": "b97df9574e60f159064c9b0fcf40565110f0225d4004aedb2b007d5d79d2d5d8",
    "url": "https://s3.amazonaws.com/pesoxpesobucket/documentos/certificados/5ceb04712f762724b6d528d6/prueba.pdf",
    "emisor": {
        "_id": "5ceb04712f762724b6d528d6",
        "nombre": "Alejandro"
    },
    "onModelEmisor": "Usuario",
    "createdAt": "2019-09-04T02:50:15.908Z",
    "updatedAt": "2019-09-04T02:50:49.881Z",
    "__v": 0,
    "txHash": "0x3696296895bb660d4fc32ad44876ad158c0d1823fe977b8a17a5f91e0eabac17"
}
				

Validar documento

Para validar un documento vía API, existen 3 alternativas:

1 - Validar vía folio de certificación (Sólo disponible para archivos PDF)

El folio de certificación es una cadena alfanumérica de 24 dígitos que se anexa en los documentos certificados por LifeChain, lo puedes encontrar en el pie de cada página del documento a validar.

  • Endpoint: https://api.lifechain.mx/documentos/*folio de certificación*/
  • Verbo HTTP: GET
  • Ejemplo de petición:

curl -X 'GET' 'https://api.lifechain.mx/documentos/5d6871762767ac003320966d' \
-H 'api_key: G8Jx0p0iYS.KpZYXHqChmEG58Lg9KpCD1O9CN0SY7oUrnmHQB5CYmXhbjO0GtirV'
				

2 - Validar vía hash 256

Esta función ayuda a validar el hash sha256 de un archivo. Para utilizar esta función, es necesario primero calcular el hash sha256 del documento (puede usar cualquier procesador online).

  • Endpoint: https://api.lifechain.mx/documentos/file-hash/*hash*
  • Verbo HTTP: GET
  • Ejemplo de petición:

curl -X 'GET' \
'https://api.lifechain.mx/documentos/file-hash/de7784a10b6ee32fdba72ee5a5a60b671a2b8afd6d6c416ebf387f12a5e686a8' \
-H 'api_key: G8Jx0p0iYS.KpZYXHqChmEG58Lg9KpCD1O9CN0SY7oUrnmHQB5CYmXhbjO0GtirV'
				

3 - Validar vía documento (base64)

Esta función ayuda a validar un documento por medio de su contenido codificado en base 64. La cadena con el contenido codificado debe de agregarse en el cuerpo de la petición con el nombre “contenido”.

  • Endpoint: https://api.lifechain.mx/documentos/base64/
  • Verbo HTTP: GET
  • Ejemplo de petición:

curl -X 'GET' 'https://api.lifechain.mx/documentos/base64/' \
-H 'api_key: G8Jx0p0iYS.KpZYXHqChmEG58Lg9KpCD1O9CN0SY7oUrnmHQB5CYmXhbjO0GtirV' \
-d 'contenido=SG9sYSBtdW5kbyEgc29tb3MgTGlmZUNoYWluIQo='
				
  • Ejemplo de respuesta exitosa:

{
    "txHashConfirmed": true,
    "_id": "5d6f2667e3e98401c24baa59",
    "fecha_certificacion": "2019-09-04T02:50:15.579Z",
    "nombre": "prueba.pdf",
    "fileHash": "b97df9574e60f159064c9b0fcf40565110f0225d4004aedb2b007d5d79d2d5d8",
    "url": "https://s3.amazonaws.com/pesoxpesobucket/documentos/certificados/5ceb04712f762724b6d528d6/prueba.pdf",
    "emisor": {
        "_id": "5ceb04712f762724b6d528d6",
        "nombre": "Alejandro"
    },
    "onModelEmisor": "Usuario",
    "createdAt": "2019-09-04T02:50:15.908Z",
    "updatedAt": "2019-09-04T02:50:49.881Z",
    "__v": 0,
    "txHash": "0x3696296895bb660d4fc32ad44876ad158c0d1823fe977b8a17a5f91e0eabac17"
}
				

Validar hash de transacción de blockchain

Esta función no válida el contenido de un documento, si no una firma regresada por Blockchain al momento de certificar un archivo. Si la certificación fue emitida por medio de LifeChain, regresará el JSON del documento, en caso contrario, el documento no será encontrado.

  • Endpoint: https://api.lifechain.mx/documentos/tx-hash/*hash de transaccion*
  • Verbo HTTP: GET
  • Ejemplo de petición:

curl -X 'GET' \
'https://api.lifechain.mx/documentos/tx-hash/0x56af9e0049477ac5e0d6f348edb877164f34b765f5225ac539791a85eb9cd04d' \
-H 'api_key: G8Jx0p0iYS.KpZYXHqChmEG58Lg9KpCD1O9CN0SY7oUrnmHQB5CYmXhbjO0GtirV'
				

Productos

Es posible que quieras conocer la documentación de APIs de nuestos otros productos, te los dejamos por aquí: