diff options
| author | Andrew Dolgov <[email protected]> | 2017-04-22 16:51:09 +0300 |
|---|---|---|
| committer | Andrew Dolgov <[email protected]> | 2017-04-22 16:51:09 +0300 |
| commit | 95f1bc0dd88378ad1833dd918386d868c59d354a (patch) | |
| tree | acf99e352a269057881e287f8a4e8977f1b8f0be | |
| parent | 8e7f0e1af19b24d772586c7d84710f4a27295880 (diff) | |
fox created page: test
| -rw-r--r-- | ApiReference.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/ApiReference.md b/ApiReference.md index 37c8556..d9f3973 100644 --- a/ApiReference.md +++ b/ApiReference.md @@ -14,7 +14,9 @@ The API is stateful. You need to login and maintain a session ID to perform further operations. Session ID should be specified using JSON parameter **sid**. I.e. - $ curl -d '{"sid":"your-session-id","op":"getVersion"}' http://example.dom/tt-rss/api/ +```bash +curl -d '{"sid":"your-session-id","op":"getVersion"}' http://example.dom/tt-rss/api/ +``` All API calls output JSON-encoded data. API can be enabled or disabled per-user in the preferences. Client parameters should be passed encoded @@ -25,7 +27,9 @@ no longer supported. Testing API calls (using curl) ------------------------------ - $ curl -d '{"op":"login","user":"you","password":"xxx"}' http://example.dom/tt-rss/api/ +```bash +curl -d '{"op":"login","user":"you","password":"xxx"}' http://example.dom/tt-rss/api/ +``` Most of the calls (except login, logout, isLoggedIn) require valid login session or will return this error object: |