Skip to content

Use the Open API ​

External systems can use the Open API to query data, manage settings, control devices, or create export tasks. Prepare an access token, organization slug, and target resource identifiers before calling it.

Choose an integration method ​

NeedMethod
Read live values, history, or resource lists on demandOpen API
Manage projects, devices, points, or controlsOpen API
Receive new device reports continuouslyData forwarding
Download a historical data fileData export

Prepare credentials and identifiers ​

  1. Ask the Owner to create an access token with the required role and project scope.
  2. Copy the organization slug from basic settings.
  3. Obtain the project ID, numeric device ID, and point identifiers from the platform or API. Use the identifier required by each endpoint; see Identifiers.

Make a first read-only request ​

Replace the example values to list projects:

bash
curl 'https://dl.yengear.com/api/v2/projects/' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  -H 'X-Organization-Slug: your-org-slug'

Check the HTTP status, project names, and project IDs in the response. If a project is missing, check organization and token scope before changing permissions.

API reference ​

TaskReference
Authentication, headers, and response conventionsOpen API overview
Organization and token managementOrganizations, Organization tokens
Project managementProjects
Device lists, binding, and maintenanceDevice management
Point settings, thresholds, and controlsDevice points
Live data and reportingDevice data
Historical data filesDownload tasks

Handle errors ​

  • 401: check the authorization header, enabled status, and expiry.
  • 403: check role, project scope, and plan restrictions.
  • 404: check resource ID, ownership, and endpoint path.

After a control timeout, check state or execution records before retrying. Record the target, time, and result in your integration logs, but omit full tokens. Clients should tolerate additional response fields.