Introduction
Welcome to the Booqable Developer Documentation!
Booqable is a rental management platform that helps businesses manage their rental inventory, customers, and orders.
Booqable API v4
Booqable API v4, also known as "Boomerang", is our modern, feature-rich REST API that provides comprehensive access to all rental management functionality.
JSONAPI
With API v4, you can manage orders, customers, products, inventory, payments, and much more. It's built on the JSON:API specification and offers advanced features like filtering, sorting, pagination, and includes for efficient data retrieval.
Ruby client
The BQBL.rb gem provides a comprehensive Ruby interface for the Booqable API. It offers a clean, object-oriented way to interact with all API endpoints.
Key features:
- Full resource coverage: Access to all Booqable API resources
- Multiple authentication methods: API keys, OAuth2, and single-use tokens
- Rate limiting: Built-in handling with retry logic
- Automatic pagination: Fetch all pages with a single call
It's perfect for Ruby applications that need to integrate with Booqable's rental management platform. To give it a try, check out the project on GitHub.
Booqable API v1
Booqable API v1 is our legacy API that provides basic rental management functionality. While still functional, it has a simpler structure compared to API v4 and lacks many of the advanced features like JSON:API compliance, sophisticated filtering, and efficient data loading through includes.
Key differences from API v4:
- Uses traditional REST endpoints with simpler JSON responses
- Limited filtering and sorting capabilities
- No JSON:API specification compliance
- Basic authentication with API keys only
- Fewer available resources and endpoints
The API v1 documentation is maintained primarily for existing customers who are still using the API. For new integrations, we strongly recommend using API v4 for its enhanced features and better performance.
Booqable Apps
Booqable Apps are modular extensions that enhance the platform by adding custom functionality like delivery carriers, payment options, theme blocks, and tracking scripts. They're distributed through the Booqable App Store and allow users to customize their rental business with specialized features for shipping, payments, website customization, and analytics integration.
For detailed information on making your own apps see the Booqable Apps documentation.