Documentación API

v1.0.0 • 27 endpoints

Guía de Inicio Rápido

1

Obtén tu API Key

Ve a Configuración → Integraciones y genera una nueva API key para tu aplicación.

2

Configura la autenticación

Incluye tu API key en el header de cada request:

Authorization: Bearer YOUR_API_KEY
3

Haz tu primer request

Prueba la API con un health check:

curl https://camino.redbroomsoftware.com/api/health

API Reference

Base URL: https://camino.redbroomsoftware.com/api

Camino is the CRM and subscription management hub for the RBS ecosystem. It provides: - **Lead Management** - Capture, score, and nurture leads - **Subscription Management** - Handle trials, conversions, and billing - **Payment Processing** - CoDi payments via Colectiva integration - **Marketing Automation** - Email sequences, A/B testing, campaigns - **Support Ticketing** - Cross-app support ticket management - **Ecosystem Manager** - Developer access to customer organizations - **Stamp Management** - CFDI stamp allocation tracking ## Authentication Most endpoints require API key authentication: ``` Authorization: Bearer {api_key} ``` ## Permissions - `subscriptions:create` - Create subscriptions - `subscriptions:read` - Read subscription data - `subscriptions:update` - Update subscriptions - `stamps:read` - Read stamp balances and packs - `stamps:write` - Consume stamps, assign to SW accounts - `leads:*` - Lead management - `support:*` - Support ticket access - `*` - All permissions

Integraciones del Ecosistema RBS

💳

Colectiva

Gateway de pagos con CoDi y SPEI

Activo
📊

Constanza

Contabilidad y facturación CFDI

Activo

La Hoja

POS para retail

Beta
🍽️

Caracol

POS para restaurantes

Beta
🐾

Cosmos Pet

Sistema veterinario

Activo
🩸

Blood Donor

Banco de sangre

Activo