Complete REST API for the TipFiti platform
All API requests require an API key sent in the header:
X-API-Key: tipfiti_api_2024_secret_key
Or as a query parameter:
?api_key=tipfiti_api_2024_secret_key
GET https://tipfiti.com/jogu-micro.php/ping
GET https://tipfiti.com/jogu-micro.php/stats
GET https://tipfiti.com/jogu-micro.php/recipients?limit=20&page=1
GET https://tipfiti.com/jogu-micro.php/recipient/1
GET https://tipfiti.com/jogu-micro.php/recipient/sanka.receipt
GET https://tipfiti.com/jogu-micro.php/businesses
GET https://tipfiti.com/jogu-micro.php/business/1
GET https://tipfiti.com/jogu-micro.php/business/sanka
GET https://tipfiti.com/jogu-micro.php/products?recipient_id=1
GET https://tipfiti.com/jogu-micro.php/product/1
GET https://tipfiti.com/jogu-micro.php/tips?limit=10&recipient_id=1
GET https://tipfiti.com/jogu-micro.php/search?q=John
GET https://tipfiti.com/jogu-micro.php/toc
POST https://tipfiti.com/jogu-micro.php/tip
Content-Type: application/json
{
"recipient_id": 1,
"amount": 50,
"phone": "254711223344",
"name": "John Doe",
"comment": "Great work!",
"rating": 5
}
POST https://tipfiti.com/jogu-micro.php/register
Content-Type: application/json
{
"name": "John Doe",
"username": "john.doe",
"email": "john@example.com",
"password": "securepassword",
"phone": "254711223344",
"role": "business_user"
}
POST https://tipfiti.com/jogu-micro.php/login
Content-Type: application/json
{
"username": "sanka.receipt",
"password": "Kenya@254"
}
| Code | Description |
|---|---|
| 200 | Success |
| 201 | Created |
| 400 | Bad Request |
| 401 | Unauthorized (Invalid API Key) |
| 403 | Forbidden |
| 404 | Not Found |
| 409 | Conflict |
| 500 | Internal Server Error |