X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=doc%2Fmd%2FREST-API.md;h=11bd1cd22f9a62a275ef3b5ce8570849545bb00e;hb=bede8e1b633d720d6a7d1b05ba367811f3ac2b87;hp=0b8aba8a76f8e906dbee97bca69c34786fadf771;hpb=f320efd689f17737ccbdef46cdc430d9e637b807;p=github%2Fshaarli%2FShaarli.git diff --git a/doc/md/REST-API.md b/doc/md/REST-API.md index 0b8aba8a..11bd1cd2 100644 --- a/doc/md/REST-API.md +++ b/doc/md/REST-API.md @@ -3,8 +3,9 @@ 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): +Please ensure that your server meets the +[requirements](Server-configuration#prerequisites) and is properly +[configured](Server-configuration): - URL rewriting is enabled (see specific Apache and Nginx sections) - the server's timezone is properly defined @@ -88,6 +89,11 @@ $signature = hash_hmac('sha512', $content, $secret); - [Android client example with Kotlin](https://gitlab.com/snippets/1665808) by [Braincoke](https://github.com/Braincoke) +### Javascript, NodeJS + +- [shaarli-client](https://www.npmjs.com/package/shaarli-client) + ([source code](https://github.com/laBecasse/shaarli-client)) + by [laBecasse](https://github.com/laBecasse) ### PHP @@ -146,3 +152,22 @@ See the reference API client: - [Documentation](http://python-shaarli-client.readthedocs.io/en/latest/) on ReadTheDocs - [python-shaarli-client](https://github.com/shaarli/python-shaarli-client) on Github + +## Troubleshooting + +### Debug mode + +> This should never be used in a production environment. + +For security reasons, authentication issues will always return an `HTTP 401` error code without any detail. + +It is possible to enable the debug mode in `config.json.php` +to get the actual error message in the HTTP response body with: + +```json +{ + "dev": { + "debug": true + } +} +```