eFirma API

API de eFirma

La API de eFirma te permite firmar documentos con tu firma electrónica, solicitar firmas, subir tus documentos y automatizar tus procesos de firmado. Para asegurar la privacidad de los datos, la API de eFirma utiliza HTTPS y los datos almacenados son encriptados con AES-256.

Endpoints

Todas las llamadas a la API tienen la siguiente base.

https://firmale.com/api

En caso de contar con un plan enterprise de geo-localización, eFirma tiene multiples servidores geo-distribuidos para cumplir con normas de privacidad de datos. Si se requiere almacenar datos en un servidor especifico, el nombre del servidor se encuentra en código Alfa-2 especificado en ISO 3166-1 y llevará la siguiente base:

https://{servidor}.firmale.com/api

Por ejemplo, para almacenar datos y transferir datos de manera especifica por nuestros servidores en México, se haría de la siguiente manera:

https://mx.firmale.com/api

Y para nuestros servidores en españa, sería de la siguiente manera:

https://es.firmale.com/api

Para accesar a los recursos y llamadas especificas, es necesario concatenar el URI a tu URL base, por ejemplo, para hacer una llamada a los documentos sería necesario concatenar el URI /documents :

https://firmale.com/api/documents

Autenticación

Para autenticar la llamada a la API, contamos con un header personalizado X-eFirma-Auth donde tendrás que especificar tu ID de Usuario y tu Llave de API en formato JSON:

curl -H 'X-eFirma-Auth:{"uid": "56d4813ce13853a2b19e1351","key": "your_key"}' \ https://mx.firmale.com/api/account

Una respuesta exitosa siempre vendra en formato JSON y en este ejemplo contendrá la información de la cuenta de la siguiente manera:

{ "companyname": "Juan Perez Enterprises SAPI de CV", "certificate": "00001000000XXXXXXXXX", "funds": "999.99", "whitelist": [ "123.123.123.1", "123.123.123.2", "123.123.123.3", "123.123.123.4" ], "geoservers": { "mx": { "whitelist": [ "123.123.123.1", "123.123.123.2" ] }, "es": { "whitelist": [ "123.123.123.3" ] }, "co": { "whitelist": [ "123.123.123.4" ] } } }