View source for API/Device registration process

= Overview =
This page describes the device registration process step by step from the perspective of each component

= Controller registering itself and optionally bundled player =

# The controller retrieves a user access token as described on: [[API/User authentication and registration|User authentication and registration]]
# The controller calls [[API/Cloud Core Protocol/createDeviceRegistrationToken|createDeviceRegistrationToken]] in Cloud Core service to retrieve a '''deviceRegistrationToken'''
# The controller register itself with the [[API/Cloud Core Protocol/addDevice|addDevice]] method in Cloud Core service
#* The '''deviceRegistrationToken''' must be used for authentication in this call instead of the user access token
#* The controller will get back an '''accessToken''' which it must store persistently
# If the controller app also contains a player, the '''accessToken''' should be passed to the player module
#* Note, since the '''accessToken''' allows anyone to access the user account and all services available to the user, the '''accessToken''' should never be passed to other devices or other apps.
#* The player sends a [[API/Player Protocol/playerStatusChanged|playerStatusChanged]] notification with '''cloudCoreStatus''' attribute indicating that it's now registered


= Controller registering a remote player =

# The controller discovers an unregistered device on the local network
#* By initializing [[API/ickP2P Protocol|ickP2p]]
#* The fact that a device is unregistered is indicated through
#** '''cloudCoreStatus''' attribute in [[API/Player Protocol/getPlayerStatus|getPlayerStatus]] method result or [[API/Player Protocol/playerStatusChanged|playerStatusChanged]] notification
#** A controller can optionally also check the '''cloudCoreUrl''' attribute from [[API/Player Protocol/getPlayerConfiguration|getPlayerConfiguration]] method result, but this is optional as different cloudCoreUrl values are only used during beta testing when there might be separate Cloud Core services for production and beta testing.
# The controller calls [[API/Cloud Core Protocol/createDeviceRegistrationToken|createDeviceRegistrationToken]] in Cloud Core service to retrieve a '''deviceRegistrationToken'''
# The controller calls [[API/Player Protocol/setPlayerConfiguration|setPlayerConfiguration]] method in Player Protocol and passes the '''deviceRegistrationToken''' as parameter
# The controller receives a [[API/Player Protocol/playerStatusChanged|playerStatusChanged]] notification from player with '''cloudCoreStatus''' attribute indicating that the player has been successfully registered


= Player being registered by a controller =

# The player announce itself on the local network
#* By initializing [[API/ickP2P Protocol|ickP2p]]
# The player gets a [[API/Player Protocol/setPlayerConfiguration|setPlayerConfiguration]] method call with a '''deviceRegistrationToken''' which the controller has requested from the cloud.
# The player register itself with the uses the [[API/Cloud Core Protocol/addDevice|addDevice]] method in Cloud Core service
#* The '''deviceRegistrationToken''' must be used for authentication in this call
#* The player will get back an '''accessToken''' which it must store persistently
# The player sends a [[API/Player Protocol/playerStatusChanged|playerStatusChanged]] notification with '''cloudCoreStatus''' attribute indicating that it's now registered