mirror of
https://github.com/koreader/koreader
synced 2024-11-18 03:25:46 +00:00
d08e22ec2e
The 'KOSync' plugin will synchronize furthest reading progress across different koreader devices after users registering their devices. The synchronizing service is open-sourced as the project [koreader/koreader-sync-server](https://github.com/koreader/koreader-sync-server).
50 lines
1.3 KiB
JSON
50 lines
1.3 KiB
JSON
{
|
|
"base_url" : "https://vislab.bjmu.edu.cn:7200/",
|
|
"name" : "koreader-sync-api",
|
|
"methods" : {
|
|
"register" : {
|
|
"path" : "/users/create",
|
|
"method" : "POST",
|
|
"required_params" : [
|
|
"username",
|
|
"password",
|
|
],
|
|
"payload" : [
|
|
"username",
|
|
"password",
|
|
],
|
|
"expected_status" : [201, 402]
|
|
},
|
|
"authorize" : {
|
|
"path" : "/users/auth",
|
|
"method" : "GET",
|
|
"expected_status" : [200, 401]
|
|
},
|
|
"update_progress" : {
|
|
"path" : "/syncs/progress",
|
|
"method" : "PUT",
|
|
"required_params" : [
|
|
"document",
|
|
"progress",
|
|
"percentage",
|
|
"device",
|
|
],
|
|
"payload" : [
|
|
"document",
|
|
"progress",
|
|
"percentage",
|
|
"device",
|
|
],
|
|
"expected_status" : [200, 202, 401]
|
|
},
|
|
"get_progress" : {
|
|
"path" : "/syncs/progress/:document",
|
|
"method" : "GET",
|
|
"required_params" : [
|
|
"document",
|
|
],
|
|
"expected_status" : [200, 401]
|
|
},
|
|
}
|
|
}
|