documentation: elaborate on REST API server & client prerequisites

Relates to https://github.com/shaarli/Shaarli/issues/903
Relates to https://github.com/shaarli/Shaarli/issues/905

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
This commit is contained in:
VirtualTam 2017-08-05 14:46:05 +02:00
parent 23daed648c
commit f320efd689
2 changed files with 19 additions and 4 deletions

View file

@ -1,6 +1,18 @@
## Usage ## Usage and Prerequisites
See the [REST API documentation](http://shaarli.github.io/api-documentation/). See the [REST API documentation](http://shaarli.github.io/api-documentation/)
for a list of available endpoints and parameters.
Please ensure that your server meets the [requirements](Server-requirements)
and is properly [configured](Server-configuration):
- URL rewriting is enabled (see specific Apache and Nginx sections)
- the server's timezone is properly defined
- the server's clock is synchronized with
[NTP](https://en.wikipedia.org/wiki/Network_Time_Protocol)
The host where the API client is invoked should also be synchronized with NTP,
see [token expiration](#payload).
## Authentication ## Authentication
@ -43,9 +55,11 @@ ewogICAgICAgICJ0eXAiOiAiSldUIiwKICAgICAgICAiYWxnIjogIkhTNTEyIgogICAgfQ==
#### Payload #### Payload
**Validity duration** **Token expiration**
To avoid infinite token validity, JWT tokens must include their creation date in UNIX timestamp format (timezone independant - UTC) under the key `iat` (issued at). This token will be accepted during 9 minutes. To avoid infinite token validity, JWT tokens must include their creation date
in UNIX timestamp format (timezone independent - UTC) under the key `iat` (issued at).
This token will be valid during **9 minutes**.
```json ```json
{ {

View file

@ -18,6 +18,7 @@ Version | Status | Shaarli compatibility
5.3 | EOL: 2014-08-14 | Yes (up to Shaarli 0.8.x) 5.3 | EOL: 2014-08-14 | Yes (up to Shaarli 0.8.x)
See also: See also:
- [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml) - [Travis configuration](https://github.com/shaarli/Shaarli/blob/master/.travis.yml)
### Dependency management ### Dependency management