The SenseCAP API utilizes five HTTP methods for accessing resources:
Make a GET request to retrieve data. GET requests will never cause an update or change to your data because they're safe and idempotent.
Use a POST request to create new resources. For example, make a POST request to a device group where the body of your request JSON is a new group.
Make a PATCH request to update a resource. With PATCH request, you only need to provide the data you want to change.
Use a PUT request to create or update a resource. This is most useful for syncing subscriber data.
Make a DELETE request to remove a resource.
Requests are authenticated with the HTTP Basic Authentication.
HTTP Basic Authentication is one of the most common ways for RESTfull API authentication. We use
Access ID as username and
Access Key as password. Every HTTP client library should have its built-in support for Basic Authentication, in this documentation we use
curl, which uses the
--user option to specify Basic Authentication credential.
All response fields follow the lowercase and underscore convention