Big picture
Use case diagrams
Create new user (phase 2 only)
Non-technical flow diagram
Code Block | ||||
---|---|---|---|---|
| ||||
title Create new user 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 |
Which endpoint NetAdmin should use
NetAdmin will POST to https://boox.fi/api/management/stb/link_user
Parameters
Please note that M is for Mandatory and O is for Optional.
Parameters | M/O | Description | Values | |||||
---|---|---|---|---|---|---|---|---|
service_token | Query | ![]() | Token generated for a service. This param will be skipped if Service-Token HTTP Header existsM | Service to which the user belongs. | String of service username. Shared separately. | |||
serial_no | Query | M | Serial Number of STB. If device does not exists with provided serial no then it will be added. | Alpha numeric string. | ||||
email | Query | ![]() | Email address address of user who is provisioned for using the STB | Valid email address. e.g. john.doe@example.com | ||||
public_keys | M | 8 Public keys which will be used to authenticate the STB.
| Query | ![]()
| key0_base64;key1_base64;...........;key7_base64 (no limit on max length). where each public key is base-64 encoded,semicolon(;) is used between keys as separator. | |||
chipset_id | Query | ![]() | mac | Query | O | STB device chipset number/ID. | chipset_id is a random list of characters (max 32 characters). | |
mac | O | Ethernet interface MAC address. | mac is a random list of characters (max 18 characters). |
Response
HTTP Code | Response |
---|---|
200 | {
|
400 |
|
401 | none |
Error Codes
Error Code | Description |
---|---|
1414 | Email does not exist |
1426 | Parameter is required |
1427 | Invalid length of chipset_id |
1428 | Invalid length of mac |
1433 | STB exists and linked |
1434 | Record already exists for value |
1435 | STB is already assigned |
1436 | Invalid email address format |
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" OTT package
TBC: What Move API must be called by KN? Do we need to provision a new endpoint like the one at Channel License
Code Block | ||||
---|---|---|---|---|
| ||||
title Entitle user to "A" OTT package KN BSS->Move API: GET /api/user/<email>/product/<product_id>/buy/option/<option_id> Move API->Irdeto: SOAP entitlement call Irdeto->Move API: 200 OK Move API->KN BSS: 200 OK |