Who needs an API?
- You have a Shopify store and want to sync with Mizan inventory
- You have a custom mobile app that reads orders
- Your accountant wants ready reports in their software
- A shipping company wants live order tracking
Available endpoints (v1)
- GET /api/v1/products
- GET /api/v1/customers
- GET /api/v1/orders
- GET /api/v1/invoices/purchase
- GET /api/v1/reports/{trial-balance, profit-loss, balance-sheet, vat}
- POST /api/v1/orders (if write_orders is enabled)
Security first
- API keys are stored as SHA-256 hashes (the full key is shown once at creation only)
- Sliding-window rate limiting, default 60 requests/minute
- Every request is logged to api_request_log
- Scoped keys: pin each key to exactly what it may read
Curl example
curl -H "Authorization: Bearer mzn_YOUR_KEY" \
https://shop.example.com/api/v1/products?limit=10
