Appearance
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
- Ask the Owner to create an access token with the required role and project scope.
- Copy the organization slug from basic settings.
- 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
| Task | Reference |
|---|---|
| Authentication, headers, and response conventions | Open API overview |
| 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
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.
