API Key (Recommended for Server-to-Server)
API keys are the primary auth method for backend integrations. Pass your key in every request using theX-API-Key header.
API keys are managed exclusively through the Myaza Dashboard.
Creating, viewing, and revoking API keys is not available via the public API.
Go to posapp.myaza.co → Settings → API Keys to manage your keys.
Getting an API Key
- Log in to the Myaza Dashboard
- Go to Settings → API Keys
- Click Generate New Key
- Copy the key — it is only shown once
API Key Scopes
When creating an API key in the dashboard, choose the appropriate scope:| Scope | Description |
|---|---|
read | Can read data (balances, transactions, webhooks) |
write | Can read and write data (transfers, wallet generation, POS sessions) |
Key Restrictions (Optional)
You can further restrict API keys from the dashboard:- IP Whitelist — limit usage to specific IP addresses
- Rate Limit — cap requests per minute
- Permissions — restrict to specific resources (e.g.,
crypto:read,staking:stake)
JWT Bearer Token (For User Sessions)
For user-facing flows (dashboards, admin panels), authenticate with email/password and use the returned JWT.Login
Response
Using the JWT
Pass the token in theAuthorization header:
JWTs are short-lived. When they expire, log in again to obtain a new token.
Choosing the Right Method
| Use Case | Method | Where to get credentials |
|---|---|---|
| Backend server calling the API | API Key | Myaza Dashboard → Settings → API Keys |
| CI/CD pipelines, cron jobs | API Key | Myaza Dashboard → Settings → API Keys |
| Admin dashboard login | JWT | POST /auth/login with your email & password |
Security Best Practices
- Never hardcode API keys in source code — use environment variables
- Rotate API keys regularly
- Use the minimum scope needed (
readunless writes are required) - Set IP whitelisting for production keys
- Set expiration dates on API keys
- Revoke unused keys immediately from the dashboard

