API
Documentación de la API (Beta)
✨ ¡Bienvenido(a) a nuestra API Beta!
Esta funcionalidad está en desarrollo activo. Esto significa que podemos añadir nuevos endpoints y funcionalidades con el tiempo. Nos encantaría recibir su feedback, así que, si necesita algo específico, póngase en contacto con nuestro equipo de soporte.
¿Qué es la API de Bolten?
Nuestra API REST le permite interactuar programáticamente con los datos de su proyecto en Bolten. Con ella, puede leer, crear y actualizar información, abriendo un mundo de posibilidades para integraciones y automatizaciones.
Casos de Uso Comunes
Crear oportunidades en Bolten a partir de un formulario en su sitio web.
Sincronizar datos de leads con una plataforma de Business Intelligence (BI).
Integrar Bolten con otros sistemas internos de gestión (ERP).
Autenticación y Autorización
La autenticación en nuestra API se realiza mediante una Clave de API (API Key).
Clave por Usuario: Cada usuario en Bolten puede tener claves de API que estarán asociadas a su cuenta.
Acceso: La clave de un proyecto concede acceso a los recursos disponibles según los permisos del usuario asociado. Por ejemplo, si el usuario es un socio y tiene permiso para acceder a algún componente del proyecto de un cliente, si existe la ruta en la API, la acción en cuestión podrá ejecutarse.
¿Cómo generar una clave de API para socios?
En el área del socio, vaya a la sección API Keys y haga clic en el botón en la esquina superior derecha (+ API Key). Hecho esto, justo debajo aparecerá un campo para que nombre su clave. Recuerde usar un nombre que tenga sentido para el uso que le dará (por ejemplo, clave n8n si se utiliza para integrar con n8n).
Después de eso, haga clic en el botón Generar. Con esto, la clave será creada y mostrada en la pantalla para ser copiada.
Copie y guarde la clave en ese momento. Después no podrá recuperarse.
Al hacer clic en el valor de la clave, ésta se copiará automáticamente al portapapeles.
Si necesita borrar la clave, en el mismo panel haga clic en el ícono de la papelera, en la misma fila donde está listada.
¿Cómo Autenticar Solicitudes?
Debe enviar su Clave de API en el encabezado Authorization de cada solicitud, utilizando el esquema Bearer.
Authorization: Bearer SU_CLAVE_SECRETA_DEL_PROYECTO
Ejemplo con CURL:
La Estructura Dinámica de las entidades
Uno de los recursos más potentes de Bolten es que la estructura de algunas entidades (sus campos) es totalmente personalizable por proyecto. Esto significa que, antes de crear o actualizar una oportunidad, contacto o negocio, es buena práctica consultar qué campos están disponibles.
Para ello, utilice el endpoint cuyo final termina en /schema. Este devolverá la estructura exacta de los campos configurados en su proyecto.
Los componentes disponibles en la API que usan la estructura dinámica son:
Opportunities (Gestión de oportunidades/Kanban)
Contacts (Gestión de contactos)
Regla de Oro para Creación y Actualización
Al enviar datos a los endpoints de creación (POST) y actualización (PATCH):
Si el nombre de un campo en su JSON coincide exactamente con el nombre de un campo configurado en el proyecto, su valor será guardado.
Si un campo enviado no existe en el proyecto, será silenciosamente ignorado.
Última actualización