RRelo Docs
API & Guías

API Reference

Referencia de los endpoints principales de la API de Relo.

API Reference

La API de Relo expone ~250 endpoints distribuidos en 28 modulos de ruta. Esta pagina documenta los endpoints principales por dominio. Para el detalle completo de cada handler, revisa el codigo fuente en src/workers/routes/ y src/workers/handlers/.

<ElkFlowDiagram chart={flowchart LR A[Cliente / Partner / Admin] --> B[Cloudflare Worker API] B --> C[Supabase Postgres] B --> D[ClickHouse Analytics] B --> E[Go Ingest Service] E --> F[R2 WAL] } />

URLs base

EntornoURL
API de plataformahttps://relo-api.quomx.workers.dev
Ingesta de eventoshttps://ingest.relo.mx
Upload de archivos grandeshttps://upload.relo.mx

Autenticacion

  • API de plataforma: Bearer token de Supabase Auth en header Authorization.
  • Ingesta: Bearer token provisto por Relo.
Authorization: Bearer <token>

Health check

GET /api/health
{
  "status": "ok",
  "version": "7.1.0",
  "uptime_sec": 864000,
  "clickhouse": "ok",
  "dragonfly": "ok",
  "supabase": "ok"
}

Endpoints por categoria

Auth

MethodEndpointAuthDescripcion
GET/api/auth/meBearerPerfil del usuario actual (role, partner_id).
DELETE/api/auth/reset-userAdminReset user para testing.

Invitations

MethodEndpointAuthDescripcion
GET/api/invitationsAdminLista invitaciones de partners.
POST/api/invitationsAdminCrear invitacion de partner.
GET/api/invitations/verify?token=PublicVerificar token.
POST/api/invitations/acceptPublicAceptar invitacion.

Client invitations

MethodEndpointAuthDescripcion
GET/api/client-invitationsAdminLista invitaciones de clientes.
POST/api/client-invitationsAdminCrear invitacion de cliente.
GET/api/client-invitations/verify?token=PublicVerificar token.
POST/api/client-invitations/acceptPublicAceptar invitacion.
DELETE/api/client-invitations/:tokenAdminRevocar invitacion.

Clients

MethodEndpointAuthDescripcion
GET/api/clientsAdminLista clientes.
POST/api/clientsAdminCrear cliente.
GET/api/clients/:idAdminDetalle cliente.
PATCH/api/clients/:idAdminActualizar cliente.
DELETE/api/clients/:idAdminEliminar cliente.
GET/api/clients/:id/segmentsAdminSegmentos del cliente.
POST/api/clients/:id/segmentsAdminCrear segmento.
PATCH/api/clients/:id/segments/:codeAdminActualizar segmento.

Partners

MethodEndpointAuthDescripcion
GET/api/partnersAdminLista partners.
POST/api/partnersAdminCrear partner.
GET/api/partners/:idPartner/AdminDetalle del partner.
PATCH/api/partners/:idAdminActualizar partner.
DELETE/api/partners/:idAdminEliminar partner.
GET/api/partners/:id/dashboardPartner/AdminDashboard del partner.
GET/api/partners/:id/ordersPartner/AdminOrdenes del partner.
GET/api/partners/:id/paymentsPartner/AdminHistorial de pagos.
GET/api/partners/:id/segment-budgetsPartner/AdminBudgets por segmento.
GET/api/partners/:id/segment-commissionsAdminComisiones por segmento.
POST/api/partners/:id/segment-commissionsAdminUpsert comision.

Campaigns

MethodEndpointAuthDescripcion
GET/api/campaigns?client_id=AdminLista campanas.
POST/api/campaignsAdminCrear campana.
PATCH/api/campaigns/:idAdminActualizar campana.
DELETE/api/campaigns/:idAdminEliminar campana.
POST/api/campaigns/:id/launchAdminLaunch campana (patterns, partners, comisiones, budgets).
GET/api/campaigns/:id/ordersAdminOrdenes filtradas por campana.
GET/api/campaigns/:id/statsAdminStats de campana.
GET/api/campaigns/:id/dailyAdminVentas diarias de campana.

Payments

MethodEndpointAuthDescripcion
GET/api/payments?client_id=&year=&month=AdminLista pagos.
POST/api/payments/generateAdminGenerar pagos del mes.
GET/api/payments/summaryAdminResumen de pagos.
PATCH/api/payments/:idAdminActualizar status de pago.
POST/api/payments/:id/evidenceAdminSubir evidencia de pago.

Rules

MethodEndpointAuthDescripcion
GET/api/rules?client_id=AdminLista reglas.
POST/api/rulesAdminCrear regla.
GET/api/rules/:idAdminDetalle de regla.
PUT/api/rules/:idAdminActualizar regla.
DELETE/api/rules/:idAdminEliminar regla.
POST/api/rules/simulateAdminSimular regla contra datos historicos.
POST/api/rules/:id/backfillAdminRe-evaluar regla historicamente.

Monthly planner

MethodEndpointAuthDescripcion
GET/api/planner?client_id=&year=&month=AdminDatos del planner.
POST/api/planner/saveAdminGuardar planner.
POST/api/planner/approveAdminAprobar y notificar.
POST/api/planner/reopenAdminReabrir mes aprobado.

Budgets

MethodEndpointAuthDescripcion
GET/api/budgets/alerts?client_id=AdminAlertas de presupuesto.
GET/api/clients/:id/relo-budgetsAdminBudgets que el cliente paga a Relo.
POST/api/clients/:id/relo-budgetsAdminCrear budget de Relo.

Imports

MethodEndpointAuthDescripcion
GET/api/importsAdminLista imports.
POST/api/imports/reset-stuckAdminReset imports stuck.
POST/api/import/fastAdminImport rapido.
POST/api/v3/upload/initAdminIniciar multipart upload.
POST/api/v3/upload/completeAdminCompletar upload.
POST/api/v3/imports/processAdminProcesar archivo subido.

Sales & Orders

MethodEndpointAuthDescripcion
GET/api/orders/:id/detailsAdminDetalle de orden.
GET/api/sales/unattributed?client_id=AdminVentas sin atribuir.
POST/api/sales/assignAdminAsignar venta a partner.
POST/api/sales/reattributeAdminRe-atribuir ventas.
POST/api/sales/bulk-attributeAdminAtribucion masiva.

Dashboard

MethodEndpointAuthDescripcion
GET/api/dashboard/overview-v2AdminOverview con segmentos.
GET/api/dashboard/partnersAdminLista partners para dashboard.
GET/api/dashboard/client-analyticsAdminAnalytics del cliente.
GET/api/dashboard/client-ordersAdminOrdenes del cliente.
GET/api/dashboard/client-geoAdminDatos geograficos.

AI Assistant

MethodEndpointAuthDescripcion
POST/api/ai-assistant/chatAdminChat con Claude.
GET/api/ai-assistant/conversationsAdminLista conversaciones.
GET/api/ai-assistant/conversations/:idAdminDetalle de conversacion.

Client portal

MethodEndpointAuthDescripcion
GET/api/client-portal/:clientId/bundleClientUser/AdminDashboard bundle (sin datos de partners/comisiones).
GET/api/client-portal/:clientId/ordersClientUser/AdminOrdenes del cliente.
GET/api/client-portal/:clientId/orders/exportClientUser/AdminExportar ordenes a CSV.

System / Monitoring

MethodEndpointAuthDescripcion
GET/api/healthNoneHealth check basico.
GET/api/system/healthAdminSalud detallada de componentes.
GET/api/system/data-freshnessAdminFreshness de datos y lag.
GET/api/admin/fraud-dashboardAdminDashboard cross-client de fraude.

Webhooks

MethodEndpointAuthDescripcion
GET/api/webhooks?client_id=AdminLista webhooks.
POST/api/webhooksAdminCrear webhook.
PATCH/api/webhooks/:idAdminActualizar webhook.
DELETE/api/webhooks/:idAdminEliminar webhook.

Ingesta de eventos

MethodEndpointAuthDescripcion
GEThttps://ingest.relo.mx/healthNoneHealth del ingest service.
POSThttps://ingest.relo.mx/ingest/batchBearerEnviar batch de eventos (max 10,000).
POSThttps://ingest.relo.mx/postback/stripeStripe signatureWebhook de Stripe.
PUThttps://ingest.relo.mx/upload/{client}/{partner}/{filename}BearerSubir CSV de partner.

Manejo de errores

CodigoSignificadoAccion
200OKRevisa rejected si aplica.
400Payload invalidoCorrige el body, no reintentar.
401No autorizadoRevisa el Bearer token.
403ForbiddenEl rol no tiene permiso.
404No encontradoVerifica IDs y slugs.
429Rate limitEspera 1-5s y reintenta.
500/502/503Error del servidorReintenta con backoff exponencial (max 3).

Rate limits

EndpointLimite
/ingest/batch100 req/min por token
/ingest/batch10,000 eventos por request
/api/*Segun plan y rol

Roles y acceso

RolAcceso tipico
adminTodos los endpoints.
client_managerClientes asignados y sus partners.
partnerSolo datos de su propio partner.
client_userSolo datos agregados de su cliente.
viewerSolo lectura.

Necesitas mas?

Para la lista completa de endpoints (~250), revisa el router modular en src/workers/routes/ y los handlers en src/workers/handlers/.

Lead-gen Pixel Case Study

Caso de estudio: integración del Relo Pixel en un sitio lead-gen con Next.js.

Seguridad

Prácticas de seguridad y autenticación en Relo.

On this page

API ReferenceURLs baseAutenticacionHealth checkEndpoints por categoriaAuthInvitationsClient invitationsClientsPartnersCampaignsPaymentsRulesMonthly plannerBudgetsImportsSales & OrdersDashboardAI AssistantClient portalSystem / MonitoringWebhooksIngesta de eventosManejo de erroresRate limitsRoles y accesoNecesitas mas?