Welcome to Kama API Documentation

This documentation is a complete guide to using the Kama system API. Here you can learn about concepts, definitions, data types, authentication, and all API endpoints.

Documentation Structure

• System Concepts — Introduction to basic concepts and system domain
• Definitions — Glossary and specialized terminology
• Data Types — Common data formats in the API
• Authentication — How to authenticate and obtain a token
• Quick Start — Quick start guide for the API

General Information

Common Conventions

Error Identifier

Error messages are returned in the following format:

{
  "success": false,
  "errors": ["Error message"]
}

Pagination

List endpoint responses include pagination information:

{
  "records": [...],
  "meta": {
    "total": 100,
    "current_page": 1,
    "per_page": 20
  }
}

Dates

Dates in the API can be sent in jalali date standard (default) or Gregorian format. Default format: YYYY-MM-DD.