![]() |
Razer Chroma SDK
v3.2
Razer Chroma SDK REST Documentation
|
Initialize Chroma SDK by sending a POST to the URI.
URL
/razer/chromasdk
Method
POST
JSON Data
{
"title": "Razer Chroma SDK RESTful Test Application",
"description": "This is a REST interface test application",
"author": {
"name": "Chroma Developer",
"contact": "www.razerzone.com"
},
"device_supported": [
"keyboard",
"mouse",
"headset",
"mousepad",
"keypad",
"chromalink"],
"category": "application"
}
| Field | Description |
|---|---|
| "title" | Title of the application. (max length 64) |
| "description" | A short desription of the application. (max length 256) |
| "author" | Author name. (max length 64) |
| "contact" | Author contact. (max length 64) |
| "device_supported" | An array of device supported. Must have at least one device type. (keyboard/mouse/headset/mousepad/keypad/chromalink) |
| "category" | Application type (application/game) |
Response:
Success
{
"sessionid" : 123456,
"uri" : http://localhost:123456/chromasdk
}
| Field | Description | String |
|---|---|---|
| "session" | Identifier for this session. | Number |
| "uri" | Uniform Resource Identifier for this instance. | String |
Fail
{
"result" : 0
}
| Field | Description | String |
|---|---|---|
| "result" | Error code defined in RzErrors.h. | Number |
Remarks
Chroma SDK MUST be initialized before accepting commands.