API Documentation
Welcome to the MirachPOS API reference. This documentation provides complete information about integrating with the MirachPOS platform.
Base URL
https://api.mirachpos.comVersion
Current API version: 0.1.0
Quick Start
- Authenticate your requests using JWT
- Explore available endpoints
- Handle errors gracefully
- Listen for webhook events
Overview
MirachPOS API is a RESTful API for managing Point of Sale operations. It supports:
- Multi-tenant SaaS architecture
- Role-based access control (RBAC)
- Offline-first capabilities
- Ethiopian payment integrations (Telebirr, Chapa)
- Real-time reporting
Authentication
All API requests require authentication via JWT Bearer token:
Authorization: Bearer <your_jwt_token>Learn more about authentication →
Rate Limits
| Endpoint Type | Limit | Window |
|---|---|---|
| Global API | 100 requests | 1 minute |
| Login | 5 attempts | 15 minutes |
| Payment | 3 attempts | 1 minute |
SDKs
Coming soon:
- JavaScript/TypeScript
- Python
- Flutter/Dart
Support
- Email: api-support@mirachpos.com
- Issues: GitHub Issues