eFirma API

Errores

La API de eFirma utiliza códigos de respuesta HTTP convencionales para indicar cuando una solicitud a la API ha sido exitosa o ha fallado. En general, códigos del tipo 2xx indican que la solicitud fué exitosa, códigos del tipo 4xx indican que ocurrio un problema con la solicitud por la información dada (un parámetro inválido, fondos insuficientes, etc.), y códigos del tipo 5xx indican que ocurrió un problema con los servidores de eFirma.

Manejo de Errores

Cuando se presenta un error, el status de HTTP irá acompañado la mayoría de las veces con un mensaje en formato JSON que contiene mas información respecto al error, por ejemplo, un error referente a un parámetro faltante contendrá el estado HTTP 400 y el siguiente JSON:

curl -H 'X-eFirma-Auth:{"uid": "your_uid","key": "your_key"}' \ https://efirma.com/api/certificate/ { "status": "error", "message": "Param 'serial' is missing for GET /certificate" }

Códigos

Los códigos de error HTTP que pueden presentarse son los siguientes:

Código Descripción
400 (Bad Request) La solicitud no fué aceptada, regularmente debido a la falta de parámetros obligatorios.
401 (Unauthorized) La autenticación para la validación de las credenciales ha fallado o las llaves son inválidas.
402 (Request Failed) Los parámetros fueron aceptados, pero ocurrió un error al procesar la solicitud.
404 (Not Found) El objeto solicitado no existe, esto puede ocurrir en solicitudes del tipo GET o DELETE.
405 (Method Not Allowed) El metodo HTTP (GET, PUT, POST, DELETE) no es válido para la URI solicitada.
500 (Internal Server Error) Ha ocurrido un error por parte de nuestros servidores.
504 (Gateway Timeout) Nuestro servidor intentó conectarse a los OCSP para la validación de certificados, pero no recibió respuesta del OCSP.