aboutsummaryrefslogtreecommitdiffstats
path: root/doc/developer/api_zot.bb
diff options
context:
space:
mode:
authorzotlabs <mike@macgirvin.com>2017-12-17 14:26:33 -0800
committerMario Vavti <mario@mariovavti.com>2017-12-18 12:47:40 +0100
commita29c84b522d0e44087098bffca5836793d6b8eda (patch)
tree59733ba41ab23ae1cab76fc3396fb95b58bae9bd /doc/developer/api_zot.bb
parentab3b126ff6a3dd76292c6c96482ed6835df966f6 (diff)
downloadvolse-hubzilla-a29c84b522d0e44087098bffca5836793d6b8eda.tar.gz
volse-hubzilla-a29c84b522d0e44087098bffca5836793d6b8eda.tar.bz2
volse-hubzilla-a29c84b522d0e44087098bffca5836793d6b8eda.zip
since api_zot (doc page) is now referenced from the project webpage, include a mention of the twitter/statusnet API plugin since that enables some degree of compatibility with dozens of third-party apps out of the box.
Diffstat (limited to 'doc/developer/api_zot.bb')
-rw-r--r--doc/developer/api_zot.bb4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/developer/api_zot.bb b/doc/developer/api_zot.bb
index b2c19d7a1..ff937bfa5 100644
--- a/doc/developer/api_zot.bb
+++ b/doc/developer/api_zot.bb
@@ -1,5 +1,9 @@
[h3]Zot API[/h3]
+Many existing social applications and tools can interface directly using the Twitter/StatusNet API, which is available using the 'twitter_api' addon.
+
+This document describes the native API; which allows direct programmatic access to several internal data structures and libraries extending beyond the basic social interface.
+
The API endpoints detailed below are relative to [code]api/z/1.0[/code], meaning that if an API is listed as [code]channel/stream[/code] the full API URL is [code][baseurl]/api/z/1.0/channel/stream[/code].
[h3]channel/export/basic[/h3]