API Documentation - Property Management System

Last Updated: May 2026

App Name: Property Management System
API Version: v1
Base URL: https://api.erudite.co.ke/residence
Authentication: Firebase Token-Based

1. Introduction

The Property Management System API allows developers to programmatically access and integrate with Property Management System functionality. This documentation covers all available endpoints, authentication methods, and data formats.

Status: Production
SLA: 99.9% uptime guarantee
Support: engage@erudite.co.ke

2. Authentication

All API requests require authentication using a Firebase token. Include your token in the Authorization header with the Bearer scheme.

Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6IjBhNjcyZjEyNzk1MzNmZDZiZGE1ZTMwZjFhZjE3Y2UzMjFhY2QzNzEiLCJ0eXAiOiJKV1QifQ...

2.1 Getting a Token

Obtain an authentication token by signing in with your Property Management System account:

POST /auth/login
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "your-password"
}

Response:
{
  "token": "eyJhbGciOiJSUzI1NiIs...",
  "expiresIn": 3600,
  "user": { ... }
}

3. Base API Information

3.1 Endpoints

Resource	Method	Endpoint	Description
Users	GET	/api/v1/users/{id}	Get user profile
Users	PUT	/api/v1/users/{id}	Update user profile
Users	DELETE	/api/v1/users/{id}	Delete user account
Data	GET	/api/v1/data	List user data
Data	POST	/api/v1/data	Create new data entry
Data	PUT	/api/v1/data/{id}	Update data entry
Data	DELETE	/api/v1/data/{id}	Delete data entry

3.2 Response Format

All API responses use JSON format. Successful responses include a status code and data:

{
  "success": true,
  "data": { ... },
  "message": "Request successful",
  "timestamp": "2026-01-06T12:00:00Z"
}

3.3 Error Responses

Error responses include an error code and message:

{
  "success": false,
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request is malformed or missing required fields",
    "details": { ... }
  },
  "timestamp": "2026-01-06T12:00:00Z"
}

3.4 HTTP Status Codes

Code	Meaning
200	OK - Request successful
201	Created - Resource created successfully
400	Bad Request - Invalid request format
401	Unauthorized - Missing or invalid authentication
403	Forbidden - Access denied
404	Not Found - Resource not found
429	Too Many Requests - Rate limit exceeded
500	Server Error - Internal server error

4. Rate Limiting

API requests are rate-limited to prevent abuse. Current limits:

Free Tier: 100 requests per hour
Standard Tier: 1,000 requests per hour
Enterprise Tier: Custom limits

Rate limit information is included in response headers:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 75
X-RateLimit-Reset: 1609873200

5. Data Privacy in API

All API requests and responses are protected by the same data security measures as the main application:

Encryption in Transit: All requests use TLS/SSL encryption
Authentication: Firebase token-based authentication required for all endpoints
Authorization: Role-based access control enforces data visibility
Audit Logging: All API requests are logged for security and compliance
Rate Limiting: Prevents brute force and DoS attacks

6. Webhooks (Coming Soon)

Real-time event notifications via webhooks will be available soon. Subscribe to events like:

Data creation, update, and deletion
User account changes
Transaction completions
System alerts and notifications

For more information, contact engage@erudite.co.ke

7. SDK Support

Official SDKs and code examples are available for:

Python
JavaScript/TypeScript
Java
C#/.NET
Go
Ruby
PHP

Find SDK documentation at github.com/erudite-systems

8. Support and Resources

Documentation: docs.erudite.co.ke
Status Page: status.erudite.co.ke
Email Support: engage@erudite.co.ke
GitHub Issues: Report bugs