RentPro API Documentation
Welcome to the RentPro API Suite. This platform provides secure, reliable, and scalable access to RentPro’s property management software. It enables developers to integrate seamlessly with core management data such as properties, units, tenants and rent information and key metrics.
Key Features
- Secure Authentication: All endpoints require API key headers.
- Consistent JSON Responses: Easy to parse and integrate into applications.
- Error Handling: Standardized error codes (
400,401,403,404) with descriptive messages. - Scalability: Designed to support high-volume data and transactions.
- Coverage: Supports all property management data.
Summary of Available APIs
| API | Purpose | Key Parameters (Request) | Key Fields (Response) |
|---|---|---|---|
| Properties Data | Retrieve list of all properties that arre actibe | x-api-key | Property ID, name, address, type, owner info, total units, rent value |
| Units Data | Retrieve list of all property units | x-api-key | Unit ID, property ID, size, type, rent amount, amenities. |
| Landlords Data | Retrieve landlord data | x-api-key | transactionId, accountNumber, amount, status |
| Tenant Data | Retrieve tenants data | x-api-key | Tenant ID, name, contact info |
| Unit Status | Retrieve the status of al units | x-api-key | Unit ID, status (occupied, vacant, under maintenance). |
| Rent Roll | Retrive list of all rents that are active | x-api-key | Property ID, unit ID, tenant name, monthly rent, payment status. |
| Due Rents | Retrieve all due and expired rents | x-api-key | Tenant ID, unit ID, due amount, due date. |
| Vacant Units | Retrieve vacant units | x-api-key | propertyno, unitno, unitname unitstatus |
| Occupied Units | Retrieve occupied units | x-api-key | propertyno, unitno, unitname unitstatus |
| Sales Report | Retrieve invoices and payments | x-api-key | invoice number, invoice date, amount, amount paid, balance |
| Dashboard Metrics | Retrieve key dashboard data metrics | x-api-key | no of properties, no of units, no of tenants, no of rents, vacant units, occupied units |
Architecture Overview
The RentPro API Suite is built on a secure, modular, and scalable architecture. It ensures that clients interact with the system through a controlled API Gateway, which routes requests to specialized microservices and communicates with the application database.
High-Level Components
- Client Layer: Mobile apps, web applications, and third-party integrations.
- API Gateway: Entry point for all requests. Handles routing, authentication, rate limiting, and logging.
-
Service Layer (Microservices):
- Customer Service
- Account Service
- Transaction Service
- Reporting Service – statements, analytics
- Security Layer: API key authentication, role-based authorization, HTTPS/TLS encryption, audit logging.
- Data Layer: RentPro database, reporting warehouse, and caching layer for performance.
- External Integrations: Payment gateways, notification services (SMS/Email), regulatory systems.
Flow Summary
Step 1: Client sends request → API Gateway
Step 2: Gateway authenticates request → routes to correct microservice
Step 3: Microservice processes request → queries database/cache
Step 4: Response returned → Gateway → Client
Step 5: Logs and audit trail stored for compliance