API
La API pública de BunnyDoc: qué está disponible hoy, por dónde empezar y las convenciones que comparten todos los endpoints.
Hoy BunnyDoc tiene una sola API pública: la API de firma electrónica, servida en
https://api2.bunnydoc.com/v1. Cubre todo el flujo de envío a firma: plantillas, contactos, el
envío de un sobre, la obtención de enlaces de firma y webhooks para todo lo que ocurre después.
API de firma electrónica
Disponible ahora. Plantillas, contactos, sobres, enlaces de firma, usuarios y webhooks.
API de facturación
Todavía no disponible. Qué puedes automatizar en facturación mientras tanto.
Todavía no existe una API de facturación
Las facturas, presupuestos, notas de crédito, el inventario y los gastos no tienen endpoints públicos. Se gestionan en la aplicación, y puedes recibir sus eventos mediante webhooks configurados en la app. Consulta API de facturación para ver qué es posible hoy.
Empieza por aquí
Comprueba que tu plan incluye acceso a la API
El acceso a la API se vende por separado. Sin él no puedes generar una clave, y
POST /v1/auth/token devuelve 403 forbidden. Busca Acceso a la API y Solicitudes de firma por
API en Configuración → Facturación → Recursos.
Crea una clave de API
Configuración → Claves de API, solo propietarios y administradores. Elige el conjunto de scopes más reducido que necesite la integración. Consulta Crear y gestionar claves de API.
Intercambia la clave por un token y construye
POST /v1/auth/token devuelve un token bearer de una
hora. Después sigue Enviar desde una plantilla: la
llamada sobre la que se construyen la mayoría de integraciones.
Dónde acaba la firma electrónica y empieza la facturación
La distinción que más confunde es la misma que en la aplicación: una tabla de factura creada dentro de un documento que se firma pertenece a firma electrónica, no a facturación.
| Lo que quieres hacer | Dónde vive | ¿API pública? |
|---|---|---|
| Enviar un documento a firma | Firma electrónica | ✅ POST /v1/envelopes/from-template |
| Cobrar a quien firma durante la firma | Firma electrónica | ✅ mediante el bloque de pago de la plantilla |
| Añadir una tabla de precios o de factura a un documento que se firma | Firma electrónica | ✅ se configura en la plantilla |
| Saber cuándo se ha firmado un documento | Firma electrónica | ✅ webhooks |
| Crear una factura independiente con su número y estado | Facturación | ❌ solo en la app |
| Enviar un presupuesto o una nota de crédito | Facturación | ❌ solo en la app |
| Gestionar productos, stock o gastos | Facturación | ❌ solo en la app |
| Saber cuándo se ha pagado una factura | Facturación | ⚠️ solo webhooks, configurados en la app |
Convenciones
Todos los endpoints de /v1 siguen las mismas reglas.
- JSON de entrada, JSON de salida: envía y espera
application/json. - Un único token bearer:
Authorization: Bearer <access_token>en todas las peticiones salvoPOST /v1/auth/token. - Ámbito de una sola empresa: una clave pertenece a una empresa y las peticiones nunca cruzan los límites de otra.
- Los mismos permisos que en la app: una clave solo puede hacer lo que permite el rol de su propietario, y sus scopes solo pueden restringirlo más, nunca ampliarlo. Consulta Usuarios y roles.
- Paginación por desplazamiento: los endpoints de listado aceptan
pageyper_pagey devuelven un objetopagination. - Códigos de error estables: ramifica según
error.code, nunca segúnmessage. Consulta la referencia de errores. - Límite de tasa por clave, no por IP, así que una dirección de salida compartida nunca hace que el tráfico de un cliente cuente contra el de otro.
Guarda las credenciales en el servidor
Una clave de API actúa en nombre de toda tu empresa. Nunca la incluyas en un navegador, una aplicación móvil ni en ningún cliente que no controles.
¿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.