Getting Started with iSale API
iSale is a comprehensive solution that bridges the gap between your business operations and KRA's eTIMS system. Our API provides seamless integration capabilities for tax compliance and management.
Base URL
https://vibraniumapi.stanbestgroup.comRequirements
- Valid API key from iSale
- KRA PIN number
- Active internet connection
- SSL certificate for secure communications
Rate Limiting
Our API implements rate limiting to ensure fair usage:
- Basic tier: 100 requests per minute
- Professional tier: 1000 requests per minute
- Enterprise tier: Custom limits
Authentication
All API requests require authentication using Bearer tokens. You'll need to include your API key in the Authorization header:
Authorization: Bearer `access_token`API Key Generation
To obtain your API key:
- Log in to your iSale dashboard
- Navigate to Settings → API Keys
- Click "Generate New Key"
- Store your key securely - it won't be shown again
API Endpoints
Sales Management
Create Sale
POST /api/sales
Create a new sales record with eTIMS compliance
Required Parameters:
- customer_id
- items (array)
- payment_method
- total_amount
Retrieve Sales
GET /api/sales
Query Parameters:
- start_date
- end_date
- page
- limit
Inventory Management
Add Item
POST /api/stock
Required Fields:
- name
- sku
- price
- tax_category
Customer Management
Register Customer
POST /api/customer
Required Fields:
- name
- contact_number
- kra_pin (optional)
Error Handling
The API uses conventional HTTP response codes to indicate success or failure of requests:
Response Codes
- 200 - Success
- 201 - Created
- 400 - Bad Request
- 401 - Unauthorized
- 403 - Forbidden
- 404 - Not Found
- 429 - Too Many Requests
- 500 - Internal Server Error
Error Response Format
{
"error": {
"code": "ERROR_CODE",
"message": "Human readable message",
"details": { }
}
}