API Overview

API Overview

EasyControl API allows external systems to interact with the platform programmatically.
You can use the API to integrate device data, automate management actions, synchronize users, and connect EasyControl with your internal systems or third-party services.

The API is designed for scenarios such as:

• Device information retrieval
• Device action execution
• Policy and application automation
• User and group synchronization
• Event and compliance data integration
• External workflow orchestration

What You Can Do with the API

With the EasyControl API, you can typically:

Manage devices

Retrieve device lists, query device details, and check current status such as enrollment, compliance, connectivity, and assigned policies.

Trigger device actions

Send commands such as lock, wipe, reboot, sync, or other supported remote operations.

Access policy and app data

Read policy assignments, application deployment status, and related configuration data.

Synchronize users and groups

Connect EasyControl with external identity systems or internal business platforms to automate user or group mapping.

Integrate events and workflows

Use API responses together with webhooks or external logic to build automated operational workflows.

Common Use Cases

1. Device inventory integration

Sync EasyControl device data into an internal dashboard, CMDB, or reporting platform.

2. Automated operations

Trigger remote device actions from internal service systems or approval workflows.

3. Enrollment-related automation

Connect registration workflows with external systems to assign devices, users, or tags automatically.

4. Compliance monitoring

Pull compliance or device status data into SIEM, SOC, or other operational systems.

5. Multi-system integration

Use EasyControl as part of a broader device lifecycle process involving IAM, ITSM, asset management, or messaging platforms.

Authentication

All API requests must be authenticated.

EasyControl API uses secure authentication to ensure that only authorized systems can access or modify platform resources.
Before calling the API, you need to obtain valid credentials and include them in each request.

Authentication details, token generation, and authorization requirements are described in the Authentication section.

Base URL

All API requests are sent to the EasyControl API base endpoint.

Example:

https://your-domain.example.com/api/

For SaaS or on-premises deployments, the actual base URL may differ depending on your environment.

Request and Response Format

The API typically uses JSON for both requests and responses.

Example request:

{
  "deviceId": "1234567890"
}

Example response:

{
  "success": true,
  "data": {
    "deviceId": "1234567890",
    "status": "online",
    "compliance": "compliant"
  }
}

HTTP Methods

The API generally follows standard HTTP methods:

• GET for retrieving data
• POST for creating resources or triggering actions
• PUT or PATCH for updating resources
• DELETE for removing resources where supported

Response Codes

The API may return standard HTTP status codes such as:

• 200 OK — Request completed successfully
• 201 Created — Resource created successfully
• 400 Bad Request — Invalid request parameters
• 401 Unauthorized — Authentication failed or missing
• 403 Forbidden — Access denied
• 404 Not Found — Resource not found
• 500 Internal Server Error — Unexpected server error

Detailed error structures are described in the Error Codes section.

Versioning

To maintain compatibility, the API may be versioned.
When versioning is enabled, clients should explicitly use the supported API version in the request path or according to the deployment standard.

Example:

https://your-domain.example.com/api/v1/

Rate Limits and Security

To protect service stability and security, API access may be subject to rate limits, permission boundaries, and audit controls.

Recommended practices:

• Use least-privilege credentials
• Rotate credentials regularly
• Log integration activities
• Avoid exposing tokens in client-side code
• Implement retry logic carefully for transient failures

Related Sections

For the next step, see:

• Authentication
• Endpoints
• Webhooks
• Examples
• Error Codes