App Registration

Register App Device

# Register app device
curl -i -X POST "https://example.ziik.io/api/app/register"
  -d '{"device":"thisisadeviceID","os":"iOS"}'

The above command returns 204 No Content on successful registration.

HTTP/1.0 204 No Content

This endpoint registers a device ID with the current user and specifies which smartphone OS family is used.

TIP

A user can have multiple device IDs registered, but a device ID can only be registered to one user. Registering the same device ID to a new user will remove it from the previous user.

HTTP Request

POST https://example.ziik.io/api/app/register

Request Parameters

ParameterTypeRequiredDescription
deviceStringYesDevice ID
osStringYes'iOS' or 'android'

Permissions Required

  • Authenticated user

Unregister App Device

# Unregister app device
curl -i -X POST "https://example.ziik.io/api/app/unregister"
  -d '{"device":"thisisadeviceID"}'

The above command returns 204 No Content on successful unregistration.

HTTP/1.0 204 No Content

This endpoint unregisters a device ID from the current user.

HTTP Request

POST https://example.ziik.io/api/app/unregister

Request Parameters

ParameterTypeRequiredDescription
deviceStringYesDevice ID

Permissions Required

  • Authenticated user