Developer API Admin
Integrate Kaltiv with your existing tools via the public REST API.
Full Documentation
The detailed technical documentation is available at:
/developer/api-docs — Complete endpoint reference, authentication and examples (accessible from the SaaS).
API Keys
Creating a Key
- Sidebar → Settings → API Keys (
/settings/api-keys) - Click New Key
- Give it a descriptive name (e.g. "Accounting integration")
- Select the required scopes (permissions)
- Set the request rate limit per minute
- Click Create Key
Important
The full key is only shown once at creation. Copy it immediately and store it securely.
Available Scopes
| Scope | Description | Methods |
|---|---|---|
employees:read | Read employee data | GET |
products:read | Read product catalogue | GET |
orders:read | Read orders | GET |
orders:write | Create/update orders | GET, POST, PUT |
invoices:read | Read invoices | GET |
customers:read | Read customer data | GET |
agriculture:read | Read agricultural data | GET |
Revoking a Key
- Go to Settings → API Keys
- Click the delete icon (🗑️) for the key
- Confirm revocation
The key is immediately disabled. Any integrations using it will stop working.
Authentication
Include your key in the HTTP header of each request:
Authorization: Bearer tk_your_key_here
Rate Limits
- Default: 100 requests/minute per key
- Configurable: 1 to 1,000 requests/minute
- Response headers show your consumption:
X-RateLimit-Remaining
Common Use Cases
| Integration | Required scopes |
|---|---|
| Accounting software | invoices:read, orders:read |
| E-commerce site | products:read, orders:write, customers:read |
| BI dashboard | employees:read, agriculture:read |
| Mobile application | orders:read, customers:read |
Response Format
All responses are in JSON format. Lists are paginated using page and per_page parameters. Errors follow the standard HTTP format (400, 401, 403, 404, 429, 500).