API v1

Production-ready endpoints for the federated CMYK ecosystem

🚀 Production • v1.0

CYAN Services

Analytics platform, data visualization, and audience personalization

  • Analytics Data GET
    /api/v1/analytics/cyan/
    Analytics and data visualization endpoints
  • Event Tracking POST
    /api/v1/analytics/track/
    Track user events and interactions
  • Performance Metrics GET
    /api/v1/analytics/metrics/
    System performance and usage statistics
  • Audience Personalization POST
    /api/v1/cyan/personalize/
    Personalize content and experiences for audiences
  • Dashboard API GET
    /api/v1/core/health/
    Core system health for analytics dashboard

MAGENTA Services

First-party data collection and audience conversion optimization

  • Data Collection POST
    /api/v1/magenta/collect/
    Collect first-party data from all touchpoints
  • Conversion Optimization POST
    /api/v1/magenta/convert/
    Drive audience conversion with optimization
  • QR Code Services GET
    /api/v1/qrcodes/
    Federated QR generation with P3 color support
  • Zip Code Deliverability POST
    /api/v1/core/deliverability/check/
    Check if delivery is available to specific zip codes
  • Delivery Statistics GET
    /api/v1/core/deliverability/stats/
    View delivery area coverage and statistics

YELO Services

Content management system and CMS services

  • Content Management GET
    /api/v1/cms/yelo/
    Content management and publishing
  • Page Builder POST
    /api/v1/cms/pages/
    Dynamic page creation and editing
  • Media Library GET
    /api/v1/cms/media/
    Media asset management
  • Template System GET
    /api/v1/cms/templates/
    Template and theme management

BLACK Services

Revenue operations, billing, and circulation management

  • Revenue Operations GET
    /api/v1/billing/black/
    Revenue tracking and management
  • Usage Billing POST
    /api/v1/billing/usage/
    Track billable usage across services
  • Client Billing GET
    /api/v1/billing/clients/
    Per-client billing and invoicing
  • Payment Processing POST
    /api/v1/billing/payments/
    Payment processing and collection
  • Circulation Management GET
    /api/v1/circulation/
    Manage distribution and circulation

Start Exploring

Jump into interactive documentation and testing tools