{"id":512,"date":"2020-11-23T17:38:54","date_gmt":"2020-11-23T17:38:54","guid":{"rendered":"https:\/\/cupl.co.uk\/?page_id=512"},"modified":"2020-12-18T09:56:53","modified_gmt":"2020-12-18T09:56:53","slug":"cuplbackend-admin-api","status":"publish","type":"page","link":"https:\/\/cupl.co.uk\/index.php\/software\/cuplbackend\/cuplbackend-admin-api\/","title":{"rendered":"Admin API"},"content":{"rendered":"\n

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

This is a password-protected API. It is the only way to create or delete a new tag and view its secretkey. Capture data can be added manually (without decoding a cuplURL).<\/p>\n\n\n\n

Add a Tag<\/h2>\n\n\n\n

cuplbackend stores data from multiple cuplTags. Each is identified by an 8-character serial <\/strong>string. <\/p>\n\n\n\n

Data captured from a tag are authenticated with an HMAC. This prevents the database from being filled with bad data. The HMAC is derived from a secret key <\/strong>of 16 random characters. <\/p>\n\n\n\n

The serial and secret key can either be supplied to the create tag<\/a> endpoint or generated automatically. Both are stored in cuplbackend and written to a cuplTag at production time.<\/p>\n\n\n\n

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

Simulate a Tag<\/h2>\n\n\n\n

The API includes a simulate<\/a> endpoint, which wraps around the encoder part of cuplcodec<\/a>. It sets up a virtual tag and feeds its sensors with a sinusoidal data stream. This makes it easy to test the backend. There is no need to pick up a phone to scan a physical cuplTag<\/a>. <\/p>\n\n\n\n

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

Create, Read, Update and Delete resources (with a token)<\/h2>\n\n\n\n

All endpoints on the cuplbackend AdminAPI require a bearer token<\/a>. This is yielded by the obtain token<\/a> endpoint upon receiving a valid CLIENT_ID and CLIENT_SECRET. Both are environment variables<\/a> and the latter must be supplied for cuplbackend to run.<\/p>\n","protected":false},"excerpt":{"rendered":"

API Documentation This is a password-protected API. It is the only way to create or delete a new tag and view its secretkey. Capture data can be added manually (without decoding a cuplURL). Add a Tag cuplbackend stores data from multiple cuplTags. Each is identified by an 8-character serial string. Data captured from a tag…<\/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 is a password-protected API. It is the only way to create or delete a new tag and view its secretkey. Capture data can be added manually (without decoding a cuplURL). Add a Tag cuplbackend stores data from multiple cuplTags. Each is identified by an 8-character serial string. Data captured from a tag are authenticated with an HMAC. This prevents the database from being filled with bad data. The HMAC is derived from a secret key of 16 random characters. The serial and secret key can either be supplied to the create tag endpoint or generated automatically. Both…<\/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 is a password-protected API. It is the only way to create or delete a new tag and view its secretkey. Capture data can be added manually (without decoding a cuplURL). Add a Tag cuplbackend stores data from multiple cuplTags. Each is identified by an 8-character serial string. Data captured from a tag are authenticated with an HMAC. This prevents the database from being filled with bad data. The HMAC is derived from a secret key of 16 random characters. The serial and secret key can either be supplied to the create tag endpoint or generated automatically. Both…<\/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\/512"}],"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=512"}],"version-history":[{"count":18,"href":"https:\/\/cupl.co.uk\/index.php\/wp-json\/wp\/v2\/pages\/512\/revisions"}],"predecessor-version":[{"id":798,"href":"https:\/\/cupl.co.uk\/index.php\/wp-json\/wp\/v2\/pages\/512\/revisions\/798"}],"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=512"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}