Descripción general de las APIs

Todas las API están disponibles a través de endpoint REST y aceptan JSON como el tipo de contenido para las solicitudes y las respuestas correspondientes.

Autenticación

Boolfy utiliza claves API para autenticar las solicitudes. Puedes ver y administrar tus claves desde API Keys en el administrador de Boolfy.

Tus claves API conllevan muchos privilegios, así que asegúrate de mantenerlas seguras. No compartas tus claves API secretas en áreas de acceso público, como GitHub, código del lado del cliente, etc.

Todas las solicitudes de API deben realizarse a través de HTTPS. Las llamadas realizadas a través de HTTP simple fallarán. Las solicitudes de API sin autenticación también fallarán.

Aquí hay un ejemplo de una invocación genérica de cURL, con la carga contenida en payload.json:

curl "https://da.boolfy.com/api/documents/$method" \ 
    -H "Authorization: Bearer BOOLFY_BEARER_KEY" \
    -H "Content-Type: application/json" \
    -d @payload.json

Boolfy Bearer Key

La autenticación Bearer de Boolfy utiliza una cadena que es el resultado de la siguiente concatenación:

Boolfy_Bearer_Key = Enterprise Id + "_" + Key + "_" + Private Key
//Por ej: 2_25874125_454gdf-rge24ger-erg5er4-rs2s2

Api Keys

Dentro de Boolfy Document Assistant podrás crear o te proporcionaran las credenciales de acceso de la Api Key.

A continuación detallamos los principales datos de la Api key

Campo
Descripción

Enterprise

Especifica la empresa a la cual pertenece el Api Key

Name

Especifica el nombre de la Api Key. Este nombre lo podrás utilizar en WorkFlows.

Key

Especifica la clave pública de acceso

Private Key

Especifica la clave privada de acceso

Solicitudes

Cualquier solicitud debe tener su tipo de contenido establecido en application/json y el payload debe enviarse en el cuerpo de la solicitud.

La estructura genérica para el endpoint de API es: https://da.boolfy.com/api/<api>/<method>

Por ejemplo, el endpoint para subir documentos es: https://da.boolfy.com/api/documents/upload

APIs disponibles

Echa un vistazo a las API disponibles actualmente:

API
Path

Documents Permite gestionar documentos

documents

Respuestas

Las respuestas, cuando están presentes, se envían en formato JSON (tipo de contenido application/json).

El formato de respuesta general de todas las APIs es el siguiente:

{
    "code": 200,
    "msg": "mensaje variable"
    "response": "contenido variable"
}

Códigos de respuesta

A continuación detallamos los códigos de respuesta posibles para cada solicutd.

Code
Nombre
Significado
200

Ok

Operación realizada exitosamente

400

Bad request

Solicitud con formato incorrecto

402

Authentication failed

ApiKey inválida o no provista

403

Method not found

El método no existe o no es válido

500

Internal server error

Error del servidor durante el procesamiento

Estados del documento

Los documentos pueden tener los siguientes estados.

Valor
Descripción

Draft

Borrador. Es el estado inicial del documento

Revised

Revisado. Opcional. Representa que se ha realizado la revisión del documento

Rejected

Rechazado. Opcional. Representa que se ha rechazado el documento

Approved

Aprobado. Opcional. Representa que se ha aprobado el documento

Estados del proceso

El procesamiento del documento puede tener los siguientes estados.

Valor
Descripción

Joined

Ingresado. Es el estado inicial del documento cuando ingresa Boolfy.

Processing

Procesando. Es cuando se esta analizando y procesando el documento.

Excluded

Excluido. Se establece cuando existen errores de formato en el documento.

Finished

Finalizado. Se establece cuando se termina de procesar el documento.

Sended

Enviado. Se establece en forma automática cuando se invoca al método GetInfo o GetList y el documento se encuentra entre estos registros. También se establece de forma automática cuando se realiza una descarga desde la plataforma en formato: JSON, CSV o XML y cuando se realiza una descarga por aplicación.

Last updated