Big picture

User Stories - business integration

New User buys new STB

1. User go to KN store and buy a new STB
2. NetAdmin then provision new user
3. NetAdmin then link the STB to that user
4. User go home and turn on the new STB
5. STB uses the key included in the firmware to sign a JWT that includes the STB serial number as a "sub" claim
6. Move API compares the serial number to the list of users set up in step 3

Existing User buys new STB

1. User go to KN store and buy a new STB
2. NetAdmin then link the STB to the existing user account
3. Optionally, NetAdmin unlinks the old STB
4. User go home and turn on the new STB
5. STB uses the key included in the firmware to sign a JWT that includes the STB serial number as a "sub" claim
6. Move API compares the serial number to the list of users set up in step 3

Existing user sell his/her STB

1. User A sells his/her STB to user B
2. User A call KN to unlink the STB from his/her account
3. User B call KN to link the STB to his/her account
4. KN captures information and passes to NetAdmin to:
   1. Unlink the STB from user account A
   2. Link the STB to user account B
5. User B turns STB on after being told the linking is complete
6. STB uses the key included in the firmware to sign a JWT that includes the STB serial number as a "sub" claim
7. Move API compares the serial number to the list of users set up in step 3 and finds user B

Use case diagrams

Create new user

This will only be done in Phase 2.  In Phase 1 users will be manually provisioned through

This API is used to add a new user account. Following rules apply:

• Email address or customer-id should not belong to any customer that is not in DELETED state; otherwise API will return an error.
• If the user with that email exists in DELETED state and his grace period is not expired, his previous registration state is restored.
• A new user is created in UNREGISTERED state.

Flow diagram

title Create new user account

NetAdmin->Move API: POST https://boox.fi/api/management/user
Move API->NetAdmin: 200 OK

Technical details

Request

Query Strings

Please note that M is for Mandatory and O for Optional.

Error Codes

Link user account to STB

Flow diagram (non-technical)

title Link user account to STB

note left of Amino factory
  At manufacture time
end note
Amino factory->Move API: List of STB serial numbers and keys
note right of NetAdmin:
  At sale time
end note
NetAdmin->Move API: User identity and their STB serial number

Technical details

NetAdmin will POST to https://boox.fi/api/management/stb/link_user

Request

POST

https://boox.fi/api/management/stb/link_user

Parameters

Please note that M is for Mandatory and O is for Optional.

serial_no

email

public_keys

Response

	"id": "123",
	"serial_no": "DNA-STB0001",
	"user": {
		"id": "10001",
		"email": "stb_user@dnastb.com"
	}
}

{
  "error" {
    "code": 9,
    "text": "Access to this resource is locked to IP addresses"
  }
}

Error Codes

How the user will sign in

See /wiki/spaces/BPLAT/pages/38550375 to see the process of letting the user sign in.

Entitle user to "A" package

The API is documented at Channel License

title Entitle user to "A" package

KN BSS->Move API: POST /user/{user_id}/relationships/channel_licenses
Move API->Irdeto: SOAP entitlement call
Irdeto->Move API: 200 OK
Move API->KN BSS: 201 CREATED

Remove user entitlement to "A" package

The API is documented at Channel License

title Remove user entitlement to package A

KN BSS->Move API: DELETE /user/{user_id}/relationships/channel_licenses/{channel_license_id}
Move API->Irdeto: SOAP entitlement call
Irdeto->Move API: 200 OK
Move API->KN BSS: 204 NO RESPONSE BODY