diff options
Diffstat (limited to 'doc/md/REST-API.md')
-rw-r--r-- | doc/md/REST-API.md | 24 |
1 files changed, 22 insertions, 2 deletions
diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md index 68a83c00..11bd1cd2 100644 --- a/doc/md/REST-API.md +++ b/doc/md/REST-API.md | |||
@@ -3,8 +3,9 @@ | |||
3 | See the [REST API documentation](http://shaarli.github.io/api-documentation/) | 3 | See the [REST API documentation](http://shaarli.github.io/api-documentation/) |
4 | for a list of available endpoints and parameters. | 4 | for a list of available endpoints and parameters. |
5 | 5 | ||
6 | Please ensure that your server meets the [requirements](Server-requirements) | 6 | Please ensure that your server meets the |
7 | and is properly [configured](Server-configuration): | 7 | [requirements](Server-configuration#prerequisites) and is properly |
8 | [configured](Server-configuration): | ||
8 | 9 | ||
9 | - URL rewriting is enabled (see specific Apache and Nginx sections) | 10 | - URL rewriting is enabled (see specific Apache and Nginx sections) |
10 | - the server's timezone is properly defined | 11 | - the server's timezone is properly defined |
@@ -151,3 +152,22 @@ See the reference API client: | |||
151 | 152 | ||
152 | - [Documentation](http://python-shaarli-client.readthedocs.io/en/latest/) on ReadTheDocs | 153 | - [Documentation](http://python-shaarli-client.readthedocs.io/en/latest/) on ReadTheDocs |
153 | - [python-shaarli-client](https://github.com/shaarli/python-shaarli-client) on Github | 154 | - [python-shaarli-client](https://github.com/shaarli/python-shaarli-client) on Github |
155 | |||
156 | ## Troubleshooting | ||
157 | |||
158 | ### Debug mode | ||
159 | |||
160 | > This should never be used in a production environment. | ||
161 | |||
162 | For security reasons, authentication issues will always return an `HTTP 401` error code without any detail. | ||
163 | |||
164 | It is possible to enable the debug mode in `config.json.php` | ||
165 | to get the actual error message in the HTTP response body with: | ||
166 | |||
167 | ```json | ||
168 | { | ||
169 | "dev": { | ||
170 | "debug": true | ||
171 | } | ||
172 | } | ||
173 | ``` | ||