API Reference

REST API documentation for the ITeas Tools Integration Platform.

Overview

The platform provides a RESTful JSON API via the rest module.

Base URL: /rest/

Authentication

Authentication endpoint:

POST /rest/common/auth/login
Content-Type: application/json

{
  "username": "user",
  "password": "password"
}

Response:

{
  "token": "your-auth-token",
  "user": {
    "id": 1,
    "username": "user"
  }
}

API Modules

The REST API is organized into modules:

Core REST Module (/rest/)

Main REST API endpoints.

Picking REST Module (/picking/rest/)

The picking module has its own nested REST API for warehouse/inventory operations.

Response Format

All responses are in JSON format:

Success Response:

{
  "data": {...},
  "status": "success"
}

Error Response:

{
  "message": "Error description",
  "status": "error",
  "code": 400
}

Configuration

REST module configuration in src/config/modules.php:

'rest' => [
    'class' => app\modules\rest\Module::class,
    'components' => [
        'response' => [
            'class' => \yii\web\Response::class,
            'format' => \yii\web\Response::FORMAT_JSON,
            'formatters' => [
                \yii\web\Response::FORMAT_JSON => [
                    'class' => \yii\web\JsonResponseFormatter::class,
                    'prettyPrint' => YII_DEBUG,
                ]
            ]
        ]
    ]
]

Available Endpoints

TIP

API endpoints are defined in REST controllers within the src/modules/rest/ directory.

For specific endpoint documentation, refer to the controller source code or contact the development team.