diff options
author | fox <[email protected]> | 2018-08-29 09:57:45 +0000 |
---|---|---|
committer | fox <[email protected]> | 2018-08-29 09:57:45 +0000 |
commit | 6c5a841da2c95703b5e45f9c5a1a398083daed64 (patch) | |
tree | 9ec2b2e310bee12c651edf24911cd3f9148ff213 | |
parent | c62858b378a59f332a09ee089f6020c065cacc1a (diff) |
Update page 'ApiReference'
-rw-r--r-- | ApiReference.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/ApiReference.md b/ApiReference.md index f5fab65..806193c 100644 --- a/ApiReference.md +++ b/ApiReference.md @@ -1,5 +1,4 @@ -JSON API Reference
-==================
+# JSON API Reference
Supported since version:1.4.0.
@@ -7,8 +6,7 @@ The API is pluggable, plugins can use host <code>add\_api\_method()</code> to add custom API calls (see
<code>classes/pluginhost.php</code> for details).
-Summary
--------
+## Summary
The API is stateful. You need to login and maintain a session ID to
perform further operations. Session ID should be specified using JSON
@@ -24,20 +22,22 @@ using JSON in HTTP POST data (supported since version:1.5.3). Older versions allowed passing parameters using HTTP GET and POST, but this is
no longer supported.
-Boolean values
----------
+## Integer values
+
+Integers can also be passed as quoted string literals, i.e. ``"0"``.
+
+## Boolean values
For boolean parameters the expected syntax is:
- string literal <code>true</code> meaning true
- anything else meaning false
-Testing API calls (using curl)
-------------------------------
+## Testing API calls (using curl)
-```bash
+<code>
curl -d '{"op":"login","user":"you","password":"xxx"}' http://example.dom/tt-rss/api/
-```
+</code>
Most of the calls (except login, logout, isLoggedIn) require valid login
session or will return this error object:
|