Provisioning Cloud API (2.1.0)
Download OpenAPI specification:
Register a device.
Authorizations:
Request Body schema: application/jsonrequired
| mac required | string Ethernet MAC address of BRAVIA. Separator shall be "-" and character shall be capital. |
| userData | string User data passed in device activation event of RMS Cloud API when the device is provisioned. Max length of User data is 4KB. |
Responses
Request samples
- Payload
{- "mac": "14-3F-A6-A1-A3-C7",
- "userData": "some-user-data"
}Response samples
- 201
- 400
- 401
- 404
- 409
- 415
{- "mac": "14-3F-A6-A1-A3-C7",
- "deviceId": "062ed2e0-24cc-4722-b388-54db05a248a9"
}Register or update provisioning key for a device.
Prior application is required to use provisioning keys for device provisioning. Registers a provisioning key for device authentication. Please call this endpoint after registering the device with POST /devices. If the request is successful, the previously registered provisioning key will be overwritten, and any ownership claim will also be removed. If you call this endpoint repeatedly within a short period, it may become temporarily unavailable.
Authorizations:
path Parameters
| mac required | string Ethernet MAC address of BRAVIA. Separator shall be "-" and character shall be capital. |
Request Body schema: application/jsonrequired
| provisioningKey required | string Provisioning key must be specified in half-width alphanumeric characters and at least 6 characters long. |
Responses
Request samples
- Payload
{- "provisioningKey": "1234ab"
}Response samples
- 201
- 400
- 401
- 404
- 409
- 415
- 429
{- "mac": "14-3F-A6-A1-A3-C7",
- "deviceId": "062ed2e0-24cc-4722-b388-54db05a248a9"
}Claim ownership of a device.
Claims ownership of the specified device. Devices for which ownership has been claimed can start provisioning with simple remote control operations. To claim ownership, you must specify the following information in addition to the MAC address:
- Serial Number
- The 7-digit serial number of the device for which ownership is being claimed.
- Description
- An arbitrary string for the user to confirm the ownership claim (up to 128 characters, ASCII printable characters only, control characters including newlines will be removed).
Notes:
- This API is only available to service providers who have been pre-approved by Sony. To obtain access, please contact your Sony representative.
- The specified Serial Number and Description will be displayed on the device screen before provisioning. Before approving, please make sure that the displayed information matches what you specified with this API.
- If ownership is claimed again for the same device, the existing claim will be overwritten with the new content. (If claimed by another service provider, the previous claim will be deleted.)
- If you call this endpoint repeatedly within a short period, it may become temporarily unavailable.
Authorizations:
path Parameters
| mac required | string Ethernet MAC address of BRAVIA. Separator shall be "-" and character shall be capital. |
Request Body schema: application/jsonrequired
| serial required | string The 7-digit serial number of the device for which ownership is being claimed. |
| description required | string An arbitrary string for the user to confirm the ownership claim (up to 128 characters, ASCII printable characters only, control characters including newlines will be removed). |
Responses
Request samples
- Payload
{- "serial": "1234567",
- "description": "string"
}Response samples
- 201
- 400
- 401
- 404
- 415
- 429
{- "mac": "14-3F-A6-A1-A3-C7",
- "deviceId": "062ed2e0-24cc-4722-b388-54db05a248a9"
}Remove ownership claim from a device.
Removes ownership claim from the specified device.
Notes:
- This API is only available to service providers who have been pre-approved by Sony. To obtain access, please contact your Sony representative.
Authorizations:
path Parameters
| mac required | string Ethernet MAC address of BRAVIA. Separator shall be "-" and character shall be capital. |
Responses
Response samples
- 401
- 404
{- "error": {
- "message": "API Key is invalid"
}
}Input an one time code.
Authorizations:
Request Body schema: application/jsonrequired
| oneTimeCode required | string One time code. |
Responses
Request samples
- Payload
{- "oneTimeCode": "123456"
}Response samples
- 200
- 400
- 401
- 409
- 415
{- "oneTimeCode": "123456",
- "device": {
- "mac": "14-3F-A6-A1-A3-C7"
}
}