Video Tutorial
WpRentals REST API
The WpRentals REST API allows developers to connect external applications and services with a WpRentals website.
You can use it to retrieve, create, update, or synchronize rental property data, booking data, and user-related information, depending on the available API endpoints and your custom integration needs.
The WpRentals API is built on the WordPress REST API framework and uses standard REST methods such as GET, POST, PUT, and DELETE.
What You Can Use the API For
The API can be used by developers to build custom integrations with external systems.
Common use cases include:
- Retrieving and displaying WpRentals listings in an external website, app, or service
- Adding new property listings from an external system
- Updating existing property information from another platform
- Synchronizing booking data with an external system
- Connecting WpRentals with mobile apps
- Connecting WpRentals with CRM tools or internal business systems
- Creating custom workflows between WpRentals and third-party services
Important Notes
The REST API is a developer tool. It requires technical knowledge of WordPress, REST API requests, authentication, data mapping, and JSON responses.
The API does not automatically create a full integration with an external platform by itself. A developer must build the connection between WpRentals and the external system.
For example, if you want to import data from another booking platform, MLS-style source, mobile app, or custom database, the external data must be mapped correctly to the WpRentals fields and booking structure.
Incorrect mapping can create missing data, incomplete listings, incorrect booking information, or other issues.
Authentication and Security
Some API actions may require authentication before they can read, create, update, or delete website data.
Always protect API credentials, access tokens, and user credentials. Do not share them publicly or add them to front-end code where visitors can see them.
For security reasons, API integrations should be created and tested by a developer.
Recommended Testing Process
Before connecting the API to a live website, we recommend testing the integration on a staging website.
Recommended steps:
- Create a staging copy of the website.
- Review the API documentation.
- Test basic GET requests first.
- Test create and update requests with sample data.
- Confirm that listings, bookings, and users are created correctly.
- Check images, prices, availability, taxes, fees, and booking rules.
- Only move the integration to the live website after all tests are confirmed.
API Documentation
https://documenter.getpostman.com/view/229114/2sAYQfE9PK#intro
Video Tutorial
Support Policy
Our support team can confirm where to find the API documentation and explain the general purpose of the WpRentals REST API.
Custom API integrations, external app development, data mapping, third-party platform synchronization, authentication setup, and custom coding are developer tasks and are not included in standard theme support.
If you need a custom integration, our team can review your requirements as a custom development request and provide a quote based on the scope of work.
You can open a support ticket and include as many details as possible about the external system, the data you want to send or receive, and the workflow you need.