Device

Register Device

The end-user journey starts with the registration of the user device. Almost every endpoint within the Consumer API requires that a device UUID (unique identifier) is passed along with this request.

The device UUID can be any identifier you may choose to uniquely identify the apparatus making the API request on behalf of the end-user. This value should be passed as part of the headers of subsequent requests.

📘

Note:

Although all device fields (except UUID) are optional, you are encouraged to provide as much information you can obtain about the device. This improves user experience since it allows for better targeting when delivering content.

POST /device

Reference: https://dash.readme.com/project/actv8me/v1.2/refs/post_device

📘

Almost every endpoint within the Consumer API requires the device UUID to be passed in the headers as "X-DEVICE-UUID".

Get Device

Upon successful registration of a device, you can use the device UUID to access its information from the database.

GET /device/{UUID}

Reference: https://dash.readme.com/project/actv8me/v1.2/refs/get_device

Update Device

At any point, you may decide to update the device information. For example: when a user updates the device locale or, in case your application has been granted GPS permission, you may want to update the location of the device.

PUT /device/{uuid}

Reference: https://dash.readme.com/project/actv8me/v1.2/refs/put_device

Delete Device

Your application should allow users to delete their device information. This could be triggered, for example, when a user decides to delete their account and/or uninstall your application.

DELETE /device/{uuid}

Reference: https://dash.readme.com/project/actv8me/v1.2/refs/delete_device