Compare commits

...

15 commits

Author SHA1 Message Date
Rainer Gümpelein 586a96f6c1 Update 4.4. op request=user_feedback 2023-11-22 18:33:07 +00:00
Rainer Gümpelein c8f7707bb0 Update 4.4. op request=user_feedback 2023-11-22 18:32:08 +00:00
Rainer Gümpelein 6a042c145a Update 4.3. op request=booking_update 2023-11-22 18:31:46 +00:00
Rainer Gümpelein 1396dcc123 Update 4.1. op request=bikes_available 2023-11-22 18:29:27 +00:00
Rainer Gümpelein 1c2005b432 Update 4.4. op request=booking_update 2023-11-22 18:23:58 +00:00
Rainer Gümpelein deb7dbc542 Update 4.3. op request=booking_update 2023-11-22 18:23:41 +00:00
Rainer Gümpelein 878b569bf3 Update 4.2. op request=booking_request 2023-11-22 18:23:25 +00:00
Rainer Gümpelein 6b31238304 Update 4.1. op request=bikes_available 2023-11-22 18:23:06 +00:00
Rainer Gümpelein 15b01708d2 Update 3.4. pri request=stations_available 2023-11-22 18:20:08 +00:00
Rainer Gümpelein da880ee8ea Update 3.4. pri request=stations_available 2023-11-22 18:18:28 +00:00
Rainer Gümpelein 6380bb9bed Update 3.4. pri request=stations_available 2023-11-22 18:12:33 +00:00
Rainer Gümpelein ccd52f0a50 Update 3.4. pri request=stations_available 2023-11-22 18:06:10 +00:00
Rainer Gümpelein 7b7fbcd047 Update 3. sharee.bike API description 2023-11-22 16:57:28 +00:00
Rainer Gümpelein 94e70c840c Update 3. sharee.bike API description 2023-11-22 16:56:17 +00:00
Rainer Gümpelein 459e242f64 Update 3. sharee.bike API description 2023-11-22 16:54:47 +00:00
6 changed files with 26 additions and 22 deletions

View file

@ -1,5 +1,5 @@
## sharee.bike API description ## sharee.bike API description
Version 4.1.10.2 Version 4.1.23.22
The document serves as a technical reference for the sharee.bike rental bike platform for rental bike client development. The rental bike management server COPRI serves as the backend system. The document serves as a technical reference for the sharee.bike rental bike platform for rental bike client development. The rental bike management server COPRI serves as the backend system.
@ -17,11 +17,11 @@ The primary server (uri_primary) is used for:
- request=authentication - request=authentication
- request=authout - request=authout
- request=stations_available - request=stations_available
- request=bikes_available
- request=user_bikes_occupied - request=user_bikes_occupied
- request=user_minianswer - request=user_minianswer
During rental bike, the operator server responsible for the rental process (uri_operator) is delivered in the rental bike JSON object. It is usesd for: The operator server (uri_operator) responsible for the rental process is used for:
- request=bikes_available
- request=booking_request - request=booking_request
- request=booking_update - request=booking_update
- request=user_feedback - request=user_feedback

View file

@ -15,20 +15,20 @@
| description | o | text<=20 | short station description | | description | o | text<=20 | short station description |
| gps | + | array | GPS: latitude, longitude | | gps | + | array | GPS: latitude, longitude |
| station | + | text | station prefix_number | | station | + | text | station prefix_number |
| station_group | + | array | station_group describes which bike_groups are allowed at the station | | station_group | + | array | deprecated, it is substituted by station_type object |
| authed | o | text | return 1 if user is authenticated on operator |
| gps_radius | + | text | geofencing by meters around station, for bike return. | | gps_radius | + | text | geofencing by meters around station, for bike return. |
| uri_operator | + | text | URI of operator-server | | uri_operator | + | text | URI of operator-server |
| bike_count | + | text | Amount of available bikes on station | | station_type | + | object | station values (see example). It can be "cargo" and/or "city" bike objects |
| operator_data | o | object | operator values (see example) | | operator_data | o | object | operator values (see example) |
| bikes_occupied | o | object | Implicit returns the json object which is defined in "request=user_bikes_occupied" |
**station_group** describes which **bike_group** are allowed at the station. **station_type** describes which **bike_group** are allowed at the station.
Groups are identified by ID. The following groups of bicycles are defined: Groups are identified by ID. The following groups of bicycles are defined:
| Defined group ID's | bike type | | Defined group ID's | bike type |
| ------ | ------ | | ------ | ------ |
| 300101 | Cargobike | | 300101 | cargo |
| 300103 | Citybike | | 300103 | city |
Keep in mind, each ID is preceded by an operator-prefix. Datatype is array, because each station can have more byke_group Keep in mind, each ID is preceded by an operator-prefix. Datatype is array, because each station can have more byke_group
Example Example
@ -56,18 +56,20 @@ https://shareeapp-primary.example.tld/APIjsonserver?request=stations_available&a
"operator_color" : "#009699" "operator_color" : "#009699"
}, },
"station" : "WUE9301", "station" : "WUE9301",
"station_group" : [
"WUE300101",
"WUE300103"
],
"gps" : { "gps" : {
"latitude" : "47.99814334149303", "latitude" : "47.99814334149303",
"longitude" : " 7.765779379576922" "longitude" : " 7.765779379576922"
}, },
"gps_radius" : "100", "gps_radius" : "100",
"bike_count" : "2" "station_type" : {
"cargo" : {
"bike_group" : "WUE300101",
"bike_count" : "2"
}
}
}, },
"WUE9302" : { "WUE9302" : {
... ...
} },
"bikes_occupied" : {}
``` ```

View file

@ -26,6 +26,7 @@
| rental_description | + | object | with tarif_elements and rental_info | | rental_description | + | object | with tarif_elements and rental_info |
| bike_type | + | object | describes the bike with some attributes | | bike_type | + | object | describes the bike with some attributes |
| smartlock_type | o | object | (under development) describes the smartlock with some attributes | | smartlock_type | o | object | (under development) describes the smartlock with some attributes |
| bikes_occupied | o | object | Implicit returns the json object which is defined in "request=user_bikes_occupied" |
**rental_description** JSON Object **rental_description** JSON Object
| key | Required | Format | Comment | | key | Required | Format | Comment |
@ -53,15 +54,15 @@
Groups are identified by ID. The following groups of bicycles are defined: Groups are identified by ID. The following groups of bicycles are defined:
| Defined group ID's | bike type | | Defined group ID's | bike type |
| ------ | ------ | | ------ | ------ |
| 300101 | Cargobike | | 300101 | cargo |
| 300103 | Citybike | | 300103 | city |
Keep in mind, each ID is preceded by an operator-prefix. Data type is array. Keep in mind, each ID is preceded by an operator-prefix. Data type is array.
Example Example
**REST request=bikes_available** for authorized users **REST request=bikes_available** for authorized users
``` ```
https://sharee-primary.example.tld/APIjsonserver?request=bikes_available&authcookie=6103_f782a208d9399291ba8d086b5dcc2509_23456789 https://sharee-operator.example.tld/APIjsonserver?request=bikes_available&authcookie=6103_f782a208d9399291ba8d086b5dcc2509_23456789
``` ```
**response** sharee JSON defaults + **response** multiple bike objects **response** sharee JSON defaults + **response** multiple bike objects
@ -125,7 +126,7 @@ https://sharee-primary.example.tld/APIjsonserver?request=bikes_available&authcoo
"WUE300029" "WUE300029"
], ],
"Ilockit_ID" : "00000000-0000-0000-0000-fc3c002a2add", "Ilockit_ID" : "00000000-0000-0000-0000-fc3c002a2add",
"uri_operator" : "https://shareeapp-op.example.tld", "uri_operator" : "https://shareeapp-operator.example.tld",
"system" : "Ilockit", "system" : "Ilockit",
"smartlock_type" : { "smartlock_type" : {
"engine" : { "engine" : {
@ -138,7 +139,8 @@ https://sharee-primary.example.tld/APIjsonserver?request=bikes_available&authcoo
}, },
"LEC5522" : { "LEC5522" : {
... ...
} },
"bikes_occupied" : {}
} }
``` ```

View file

@ -40,7 +40,7 @@ The following lock states are implemented:
Example Example
**request** starts bike rental and unlock smartlock at once. lock_state=unlocked can also be done on second request. **request** starts bike rental and unlock smartlock at once. lock_state=unlocked can also be done on second request.
``` ```
https://sharee-zr01.example.tld/APIjsonserver?request=booking_update&bike=FR1540&state=occupied&lock_state=unlocked&authcookie=6103_7dc3c95028d06c9663378f6d44346de7_12345678 https://sharee-operator.example.tld/APIjsonserver?request=booking_update&bike=FR1540&state=occupied&lock_state=unlocked&authcookie=6103_7dc3c95028d06c9663378f6d44346de7_12345678
``` ```
**response** sharee JSON defaults + **response** rental states in `user_bikes_occupied` JSON-objects **response** sharee JSON defaults + **response** rental states in `user_bikes_occupied` JSON-objects

View file

@ -20,7 +20,7 @@
Example Example
**REST request=user_feedback** **REST request=user_feedback**
``` ```
https://shareeapp-fr01.copri-bike.de/APIjsonserver?request=user_feedback&bike=FR_1538&message=alles%20gut&bike_broken=1&authcookie=6103_ad720ed63bd40039e4abe8a9ad7315e1_23456789 https://shareeapp-operator.example.tld/APIjsonserver?request=user_feedback&bike=FR1538&message=alles%20gut&bike_broken=1&authcookie=6103_ad720ed63bd40039e4abe8a9ad7315e1_23456789
``` ```
**response** is just the **sharee JSON default** with user_feedback **response** is just the **sharee JSON default** with user_feedback