Changelog

​

🆕 New API Endpoints

​

New Endpoints

• POST /api/component/findPaginatedComponentEventsByAccessControlledDoor - Retrieve all component events relevant to the specified AccessControlledDoor

• POST /api/report/getOccupancyCountsV2 - Get occupancy counts V2

​

🆕 New API Endpoints

​

New Endpoints

• POST /api/report/getBatchThresholdCrossingCountReport - Get batch threshold crossing count report
• POST /api/report/getThresholdCrossingCountReportForOrg - Get org wide batch threshold crossing count report

​

🆕 New API Endpoints

​

New Endpoints

• POST /api/component/elevator/addAccessControlledElevatorLandingLabel - Create a label that can be assigned to an access controlled elevator landing
• POST /api/component/elevator/findAccessControlledElevatorLandingShadows - Find access controlled elevator landing shadows within the org
• POST /api/component/elevator/findAccessControlledElevatorLandingShadowsByLocation - Find access controlled elevator landing shadows within the specified location
• POST /api/component/elevator/getAccessControlledElevatorLandingLabelsForOrg - Get all access controlled elevator landing labels for the organization
• POST /api/component/elevator/removeAccessControlledElevatorLandingLabel - Remove a label to an access controlled elevator landing

​

📐 Documentation Navigation Restructure

​

New Navigation Structure

• Getting started articles and basic integration approaches
• Quick start guide and API overview

• Detailed implementation guides organized by product category:
  • Cameras: Video streaming, player implementation, advanced techniques
  • Access Control: QR code access control and door management
  • Alarm Monitoring: Placeholder for future alarm monitoring guides
  • IoT Sensors: Placeholder for future sensor integration guides
  • More: Backup footage, webhook listeners, and other advanced topics

• Integration guides for no-code/low-code platforms:
  • Zapier integration
  • Make.com integration
  • N8N integration
• AI approaches:
  • Documentation MCP (Model Context Protocol) for AI tool integration

• Complete REST API reference with 846+ endpoints
• Live endpoint testing directly in the documentation
• Auto-generated from OpenAPI specification

​

Benefits

• Better Organization: Content is now grouped by use case and complexity level
• Easier Discovery: Product-specific guides are easier to find
• Clearer Paths: From getting started → advanced implementations → API reference
• Future-Ready: Placeholder sections for upcoming content (Alarm Monitoring, IoT Sensors)

​

🆕 New API Endpoints

​

New Endpoints

• POST /api/alertmonitoring/disableMonitoringForLocation - Disable monitoring for location
• POST /api/alertmonitoring/enableMonitoringForLocation - Enable monitoring for location

​

🎉 New Documentation Launch

​

Platform Modernization

• Modern Documentation Framework: Migrated to Mintlify for improved performance and interactive components
• Enhanced Search: Lightning-fast documentation search with instant results
• Mobile Optimized: Fully responsive design that works beautifully on all devices
• Dark Mode Support: Toggle between light and dark themes for comfortable reading

​

API Documentation

• 846+ Endpoints: Complete coverage of the Rhombus API with auto-generated documentation
• Interactive Components: Rich MDX components including code groups, tabs, and expandable sections
• Real-time Sync: Nightly automated updates ensure documentation stays current with production API
• Smart Organization: Endpoints grouped by service area with logical subgroups (Create & Add, Get & Find, Update & Modify, Delete & Remove)

​

Developer Resources

• Implementation Guides:
  • Advanced video player implementation with HLS streaming
  • Webhook listener setup and configuration
  • Real-world integration patterns
• Code Examples: Multi-language examples in cURL, Python, JavaScript, and Go
• OpenAPI Specification: Downloadable spec at https://api2.rhombussystems.com/api/openapi/public.json
• MCP Integration: Connect AI assistants directly to documentation via Model Context Protocol

​

Navigation & Structure

• Tabbed Interface: Clean separation between Guides and API Reference sections
• Improved Hierarchy: Logical grouping of related content for easier discovery
• Quick Links: Direct access to frequently used resources
• Breadcrumb Navigation: Always know where you are in the documentation

​

Content Enhancements

• Getting Started Guide: Updated quickstart with clear step-by-step instructions
• Authentication Documentation: Comprehensive coverage of API key and certificate-based auth
• Integration Examples: Practical examples for common use cases:
  • Camera video streaming
  • Access control management
  • Event monitoring and webhooks
  • Environmental sensor data
• Best Practices: Security guidelines, rate limiting, and error handling

​

Developer Experience

• AI Tool Integration:
  • Claude Code support with CLAUDE.md guidance file
  • Cursor editor compatibility
  • Windsurf integration with custom rules
  • MCP server for AI assistants
• Context Files: Auto-generated llms.txt and llms-full.txt for AI tools
• Automation: GitHub Actions workflows for maintaining up-to-date content
• Split OpenAPI Specs: Category-based spec files for easier AI processing (60+ categories)

​

Technical Infrastructure

• Automated Workflows:
  • Nightly OpenAPI spec updates (2 AM UTC)
  • Automated context file generation (3 AM UTC)
  • Automatic spec splitting for AI tools
• Quality Assurance: Link validation and broken link detection
• Performance: Fast page loads with CDN optimization
• Reliability: 15-minute timeout protection and retry logic

​

Documentation Quality

• Zero Broken Links: All internal and external links verified and functional
• Consistent Formatting: Standardized frontmatter and component usage
• Clear Examples: Realistic, working code examples throughout
• Comprehensive Coverage: Every API endpoint documented with parameters and responses

​

What’s Next

• SDK documentation and examples
• More implementation guides for complex workflows
• Video tutorials and walkthroughs
• Community-contributed examples
• Enhanced search with AI-powered suggestions

​

Feedback Welcome