{"id":515,"date":"2020-11-23T17:41:20","date_gmt":"2020-11-23T17:41:20","guid":{"rendered":"https:\/\/cupl.co.uk\/?page_id=515"},"modified":"2020-12-16T10:40:40","modified_gmt":"2020-12-16T10:40:40","slug":"cuplbackend-consumer-api","status":"publish","type":"page","link":"https:\/\/cupl.co.uk\/index.php\/software\/cuplbackend\/cuplbackend-consumer-api\/","title":{"rendered":"Consumer API"},"content":{"rendered":"\n

API Documentation<\/a><\/p>\n\n\n\n

This API is designed to be accessed by regular end-users. Tags can only be viewed (not deleted or created). Captures can be created, but only by scanning a tag with a recognised serial and secretkey. Samples from multiple captures can be retrieved and de-duplicated.<\/p>\n\n\n\n

Capture Creation<\/h2>\n\n\n\n

The create capture<\/a> endpoint passes data extracted from a cuplURL to the decoder<\/a>. Output is persisted in the database as a capture<\/strong>. Each is stored as a child of the tag that created the cuplURL. This list of captures constitutes a long-term record of the temperature and humidity measured by cuplTag. It extends datalogging capacity well beyond the on-board 1KB circular buffer. <\/p>\n\n\n\n

The decoder requires a secret key to validate the HMAC part of the cuplURL. Without this, no capture is created and an error message is raised – the cuplURL could have originated from anywhere. The secret key is a random 16-character string assigned<\/a> to each tag in production. It is looked up before the decoder is invoked. <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Sample De-duplication<\/h2>\n\n\n\n

The cuplTag writes samples to a circular buffer at 10 minute intervals. It takes roughly one day for old samples to be overwritten. A subset of two captures taken within one day will be identical. <\/p>\n\n\n\n

The user will want to view all samples stitched together on a timeline, with no duplicates. This is much better than viewing one capture at-a-time. cuplBackend facilitates this with the unique samples<\/a> endpoint. It returns sample data between a start and end timestamp. <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Physical Access Endpoints<\/h2>\n\n\n\n

When the create <\/a>capture<\/a> endpoint is called a tagtoken <\/strong>is returned, which expires after 10 minutes. This <\/strong>can then be passed to POST, PUT and DELETE endpoints described below. The token proves the user has physical access<\/strong> to one tag and is therefore likely to own it. Therefore, some write privileges are granted.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Description<\/h3>\n\n\n\n

Users can label cuplTags by making a PUT request to the tag description<\/a> endpoint. <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Webhooks<\/h3>\n\n\n\n

When a capture is created by cuplBackend, it can be transmitted to a 3rd party application by means of a reverse API call (webhook). In other words: cuplbackend can POST new captures to a URL of your choice.<\/p>\n\n\n\n

Webhooks eliminate the need for 3rd party applications polling cuplBackend for new tag data. The URL is set from a frontend application. A tagtoken is required (see above). <\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Browse Tags, Captures and Samples<\/h2>\n\n\n\n

Without authentication, users are free to read non-sensitive data on tags, captures and samples. Rate limits are adjusted with environment variables.<\/p>\n","protected":false},"excerpt":{"rendered":"

API Documentation This API is designed to be accessed by regular end-users. Tags can only be viewed (not deleted or created). Captures can be created, but only by scanning a tag with a recognised serial and secretkey. Samples from multiple captures can be retrieved and de-duplicated. Capture Creation The create capture endpoint passes data extracted…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":173,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"inline_featured_image":false,"spay_email":""},"featured_image_urls":{"full":"","thumbnail":"","medium":"","medium_large":"","large":"","1536x1536":"","2048x2048":""},"post_excerpt_stackable":"

API Documentation This API is designed to be accessed by regular end-users. Tags can only be viewed (not deleted or created). Captures can be created, but only by scanning a tag with a recognised serial and secretkey. Samples from multiple captures can be retrieved and de-duplicated. Capture Creation The create capture endpoint passes data extracted from a cuplURL to the decoder. Output is persisted in the database as a capture. Each is stored as a child of the tag that created the cuplURL. This list of captures constitutes a long-term record of the temperature and humidity measured by cuplTag. It…<\/p>\n","category_list":"","author_info":{"name":"malcolmmackay","url":"https:\/\/cupl.co.uk\/index.php\/author\/malcolmmackay\/"},"comments_num":"0 comments","featured_image_urls_v2":{"full":"","thumbnail":"","medium":"","medium_large":"","large":"","1536x1536":"","2048x2048":""},"post_excerpt_stackable_v2":"

API Documentation This API is designed to be accessed by regular end-users. Tags can only be viewed (not deleted or created). Captures can be created, but only by scanning a tag with a recognised serial and secretkey. Samples from multiple captures can be retrieved and de-duplicated. Capture Creation The create capture endpoint passes data extracted from a cuplURL to the decoder. Output is persisted in the database as a capture. Each is stored as a child of the tag that created the cuplURL. This list of captures constitutes a long-term record of the temperature and humidity measured by cuplTag. It…<\/p>\n","category_list_v2":"","author_info_v2":{"name":"malcolmmackay","url":"https:\/\/cupl.co.uk\/index.php\/author\/malcolmmackay\/"},"comments_num_v2":"0 comments","_links":{"self":[{"href":"https:\/\/cupl.co.uk\/index.php\/wp-json\/wp\/v2\/pages\/515"}],"collection":[{"href":"https:\/\/cupl.co.uk\/index.php\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/cupl.co.uk\/index.php\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/cupl.co.uk\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/cupl.co.uk\/index.php\/wp-json\/wp\/v2\/comments?post=515"}],"version-history":[{"count":37,"href":"https:\/\/cupl.co.uk\/index.php\/wp-json\/wp\/v2\/pages\/515\/revisions"}],"predecessor-version":[{"id":709,"href":"https:\/\/cupl.co.uk\/index.php\/wp-json\/wp\/v2\/pages\/515\/revisions\/709"}],"up":[{"embeddable":true,"href":"https:\/\/cupl.co.uk\/index.php\/wp-json\/wp\/v2\/pages\/173"}],"wp:attachment":[{"href":"https:\/\/cupl.co.uk\/index.php\/wp-json\/wp\/v2\/media?parent=515"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}