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:
Boolfy Bearer Key
La autenticación Bearer de Boolfy utiliza una cadena que es el resultado de la siguiente concatenación:
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
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:
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:
Códigos de respuesta
A continuación detallamos los códigos de respuesta posibles para cada solicutd.
Estados del documento
Los documentos pueden tener los siguientes estados.
Last updated
