API
Las API de BunnyDoc — cómo se dividen la Firma electrónica y la Facturación en dos API independientes, y por dónde empezar.
La API de BunnyDoc sigue la misma división que la aplicación: la Firma electrónica y la Facturación son dos API independientes. Viven bajo una misma cuenta y comparten la autenticación, pero tienen sus propios endpoints y sus propios recursos. No existe una API combinada.
API de Firma electrónica
Sobres, firmantes, campos, plantillas, bloques de documento y pagos cobrados durante la firma.
API de Facturación
Facturas, presupuestos, notas de crédito, facturas recurrentes, inventario, gastos y pagos.
Elegir la API correcta
La distinción que más confunde es la misma que en la aplicación: una tabla de factura creada dentro de un documento a firmar pertenece a la Firma electrónica, no a la Facturación.
| Lo que quieres hacer | Usa |
|---|---|
| Enviar un documento para firmar | API de Firma electrónica |
| Añadir una tabla de precios o de factura a un documento a firmar | API de Firma electrónica |
| Cobrar a un firmante mientras firma | API de Firma electrónica |
| Crear una factura independiente con su propio número y estado | API de Facturación |
| Enviar un presupuesto o una nota de crédito | API de Facturación |
| Gestionar productos, stock o gastos | API de Facturación |
Los contactos, usuarios, roles y la configuración de la empresa son compartidos, así que se acceden igual desde cualquiera de las dos API.
Autenticación
Ambas API usan las mismas credenciales, emitidas por empresa. Una solicitud lleva la credencial y la empresa en cuyo nombre actúa; cada respuesta está limitada a esa empresa.
Guarda las credenciales en el servidor
Las credenciales de API actúan en nombre de toda tu empresa. No las incluyas nunca en un navegador, una aplicación móvil ni en ningún cliente que no controles.
Convenciones
- JSON de entrada y de salida — envía y espera
application/json. - Limitado a una empresa — cada recurso pertenece a una empresa y las solicitudes nunca cruzan ese límite.
- Los mismos permisos que en la aplicación — una credencial solo puede hacer lo que permita su rol. Consulta Usuarios y roles.
- Con límite de frecuencia — las ráfagas sostenidas se limitan; espera y reintenta cuando ocurra.
Referencia de endpoints
La referencia por endpoint de cada API se publica en su propia sección: empieza por la API de Firma electrónica o la API de Facturación.
¿Cómo creo plantillas de permisos?
Crea conjuntos reutilizables de permisos que puedes aplicar a los miembros del equipo en lugar de configurar el acceso clave por clave.
API de firma electrónica
Envía documentos para firmar directamente desde tus propios sistemas: intercambia una clave de API por un token, crea sobres a partir de plantillas, gestiona contactos y obtén enlaces de firma mediante una API REST sencilla.