Test sawgger 2.0
Description: I've identified two minor UI points that need adjustment (not priority one) regarding the Short Description in the Hub Listing. Hub Listing Tab Text Update: Current Text: "Describe the API in a few plain text words. Used for the API's card on the API Hub and at the top of the API listing's Endpoints tab." Issue: The last part of this statement is no longer accurate with the New Hub…
22 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Test sawgger 2.0 endpoints
| Method | Endpoint | Description |
|---|---|---|
| Authentication | ||
| POST |
/authentication /authentication |
### Response data example: ``{authenticated: true, user_id: 240471648, token: .eyJ1c2VybmFtZSI6InRlc3QiLCJ1c2VyX2lkIjoyNDA0NzE2NDgsImlhdCI6MTUyNjk5ODQxOX0.opQW1yTczP7vuiIkI1Skuy8y… |
| Modules | ||
| POST |
zoneChange /users/{user_id}/modules/{module_udid}/zones |
Change zone parameters (L-7, L-8, WiFi 8S, ST-8S WiFi) \n Set constant temperature: 1. **Set constant temperature**: \ POST data example: { "mode": { "id": 210, "parentId": 101,… |
| POST |
registerModule /users/{user_id}/module/registration |
``` Field Type require module_name String true registration_code Integer true notification_email String false additional_information String false accept_post_policy Bool false "I… |
| GET |
/users/{user_id}/modules /users/{user_id}/modules |
|
| PUT |
Change module location /users/{user_id}/modules/{module_udid}/info/location |
``` Field Type require Options Descryption post_policy_accepted Boolean yes true/false I agree to the processing of additional data (country, postcode) zip_code String no… |
| PUT |
Change module information /users/{user_id}/modules/{module_udid}/info/data |
``` Field Type require Options module_name String no phone_number Integer no additional_information String no |
| GET |
/users/{user_id}/modules/{module_udid} /users/{user_id}/modules/{module_udid} |
|
| PUT |
Delete module /users/{user_id}/modules/{module_udid}/info/delete_module |
|
| PUT |
Change module time zone /users/{user_id}/modules/{module_udid}/info/time_zone |
``` Field Type require Options gmt_id Integer yes GET /JSON/time_zones.json |
| POST |
Force Data Synchronization /users/{user_id}/modules/{module_udid}/force_data_sync |
|
| PUT |
Change zone name/icon /users/{user_id}/modules/{module_udid}/zones/{zones_id} |
```Field Type require Options zones_id Integer yes description_id Integer yes name String yes max length: 12 characters icons_id Integer yes 0-7 (living_room: 0, bathroom: 1,… |
| Setting schedules | ||
| POST |
zoneSchedulesChange /users/{user_id}/modules/{module_udid}/zones/{zone_id}/local_schedule |
### POST data example: ``` { modeId = 100 schedule = { id: 150, index: -1, p0Days: ["1", "1", "1", "1", "1", "0", "0"], p0Intervals: [{start:0, stop: 480, temp: 180}, {start:… |
| POST |
zoneGlobalSchedulesChange /users/{user_id}/modules/{module_udid}/global_schedule |
**setInZones(array of objects)**: array of zoneIds to be set with their corresponding modeIds. This cannot be empty. Zone(s) must belong to the module specified by {module_udid}… |
| Menu | ||
| GET |
/users/{user_id}/modules/{module_udid}/menu/{menu_type} /users/{user_id}/modules/{module_udid}/menu/{menu_type} |
### Valid values: (type 1) { "menuType": "MU", "type": 1, "id": 2063, "parentId": 30002, "access": true, "txtId": 296, "wikiTxtId": 0, "iconId": 87, "params": { "format": 1,… |
| POST |
updateMenuParams /users/{user_id}/modules/{module_udid}/menu/{menu_type}/ido/{ido} |
``` Parameter Type Required Description menu_type String yes Options: 'MU', 'MI', 'MS', 'MP' ido Number yes Parameter ido type 1 - Valid values POST data example: { "value": 25 }… |
| Language / i18n / Subtitles | ||
| GET |
/i18n/{language}/{tag} /i18n/{language}/{tag} |
``` Parameter Type Required Description language String yes Options: 'en', 'fr', 'it', 'es', 'nl', 'pl', 'de', 'cs', 'sk', 'hu', 'ro', 'lt', 'et', 'ru', 'si', 'hr' tag String no |
| Account | ||
| POST |
createAccount /create_account |
**POST data example**: { username: 'test', password: 'yourpassword', email: '[email protected]', language: 'en' } \ **Response example**: { status: 'success', code: 1, message:… |
| POST |
/account_activation/{uuid} /account_activation/{uuid} |
|
| Statistics | ||
| GET |
/modules/{module_uuid}/statistics/linear/range/{range}/month/{month}/year/{year} /modules/{module_uuid}/statistics/linear/range/{range}/month/{month}/year/{year} |
|
| GET |
/modules/{module_uuid}/statistics/linear/range/{range} /modules/{module_uuid}/statistics/linear/range/{range} |
``` Field Type require Options module_uuid String true range String true 'day' - last day, 'week' - last week, 'month' - last month or selected month month Integer no… |
| GET |
/modules/{module_uuid}/statistics/linear/range/{range}/month/{month} /modules/{module_uuid}/statistics/linear/range/{range}/month/{month} |
|
| Alarm History | ||
| GET |
/users/{user_id}/modules/{module_udid}/alarm_history/from/{from}/to/{to}/type/{type} /users/{user_id}/modules/{module_udid}/alarm_history/from/{from}/to/{to}/type/{type} |
```Field Type require Options from String yes start date e.g. 2023-02-01 to String yes end date e.g. 2023-02-11 type String yes Options: 'all', 'alarm', 'warning', 'notification' |
Test sawgger 2.0 pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|
| PRO | Free | — |
|
