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

Need	Method
Read live values, history, or resource lists on demand	Open API
Manage projects, devices, points, or controls	Open API
Receive new device reports continuously	Data forwarding
Download a historical data file	Data 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:

curl 'https://dl.yengear.com/api/v2/projects/' \
  -H 'Authorization: Bearer YOUR_ACCESS_TOKEN'

An access token already belongs to one organization, so the request needs no organization header.

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

Task	Reference
Base URL, response format, and endpoint index	Open API reference
Tokens, roles, and project scope	Authentication
Error format and reason codes	Errors
Organization and token management	Organizations, Organization tokens
Project management	Projects
Device lists, binding, and maintenance	Device management
Point settings, thresholds, and controls	Device points
Live data and reporting	Device data
Historical data files	Download tasks

Handle errors

• 403 with an invalid-token message: check the authorization header, enabled status, and expiry. The API returns 403, not 401, for credential failures.
• 403 otherwise: 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.