UBOSS REST API
We're building a comprehensive REST API that will allow developers to integrate UBOSS with external systems, build custom workflows, and automate business processes. The API is currently in development, with an early access programme available for interested developers and partners.
Overview
The UBOSS API will be a standard RESTful JSON API served over HTTPS. Key details:
- Base URL: https://app.uboss.co.za/api/v1/
- Authentication: API key-based authentication via HTTP headers
- Format: JSON request and response bodies
- Rate Limiting: Reasonable rate limits to ensure platform stability
- Versioning: URL-based versioning (v1, v2, etc.)
Planned Endpoints
The following endpoints are planned for the initial API release. Endpoint availability may change during development.
Customers
| Method | Endpoint | Description |
|---|---|---|
| GET | /customers | List all customers (paginated) |
| GET | /customers/:id | Get a single customer by ID |
| POST | /customers | Create a new customer |
| PUT | /customers/:id | Update an existing customer |
| DELETE | /customers/:id | Delete a customer |
Invoices
| Method | Endpoint | Description |
|---|---|---|
| GET | /invoices | List all invoices (paginated, filterable) |
| GET | /invoices/:id | Get a single invoice by ID |
| POST | /invoices | Create a new invoice |
| PUT | /invoices/:id | Update an existing invoice |
| POST | /invoices/:id/send | Email an invoice to the customer |
| GET | /invoices/:id/pdf | Download invoice as PDF |
Inventory
| Method | Endpoint | Description |
|---|---|---|
| GET | /products | List all products (paginated) |
| GET | /products/:id | Get a single product by ID |
| POST | /products | Create a new product |
| PUT | /products/:id | Update product details or stock levels |
| GET | /products/low-stock | List products below minimum stock threshold |
Repairs / Workshop
| Method | Endpoint | Description |
|---|---|---|
| GET | /repairs | List all repair jobs (paginated, filterable by status) |
| GET | /repairs/:id | Get a single repair job by ID |
| POST | /repairs | Create a new repair job |
| PUT | /repairs/:id | Update repair job details or status |
Payments
| Method | Endpoint | Description |
|---|---|---|
| GET | /payments | List all payments (paginated) |
| POST | /payments | Record a new payment against an invoice |
Request Early Access
The UBOSS API is currently in development. If you're a developer or partner who'd like early access to test and integrate, we'd love to hear from you.
Contact us:
Please include details about your use case and what endpoints you'd need. This helps us prioritise development.
Authentication
All API requests will require authentication using an API key. API keys can be generated in your UBOSS account settings. Include your key in the request header:
Authorization: Bearer YOUR_API_KEY
API keys are scoped to your business account and inherit the permissions of the user who created them. Keep your API keys secure and never expose them in client-side code.
Rate Limiting
To ensure fair usage and platform stability, the API will enforce rate limits:
- Professional plan: 100 requests per minute
- Enterprise plan: 500 requests per minute
- Enterprise plans: Custom limits available
Rate limit headers will be included in all API responses so you can monitor your usage.