diff options
| author | redmatrix <redmatrix@redmatrix.me> | 2015-10-10 09:11:52 +1100 |
|---|---|---|
| committer | redmatrix <redmatrix@redmatrix.me> | 2015-10-10 09:11:52 +1100 |
| commit | 209882d5a9475f627365214e2ea8c3dafccff5ca (patch) | |
| tree | f231dba9f43c9b75aed462ee6e20e86e0bfbe954 | |
| parent | 2999096221544dd2073db64c789fc1a3e1d493cc (diff) | |
| parent | e22448fb5ce9d75586055f811b75b979a56bfd8f (diff) | |
| download | volse-hubzilla-209882d5a9475f627365214e2ea8c3dafccff5ca.tar.gz volse-hubzilla-209882d5a9475f627365214e2ea8c3dafccff5ca.tar.bz2 volse-hubzilla-209882d5a9475f627365214e2ea8c3dafccff5ca.zip | |
Merge pull request #76 from kenrestivo/update-post-docs
Update the post docs adding how to post to a channel
| -rw-r--r-- | doc/api_posting.bb | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/doc/api_posting.bb b/doc/api_posting.bb index fa9558268..c708ad143 100644 --- a/doc/api_posting.bb +++ b/doc/api_posting.bb @@ -4,19 +4,20 @@ The API allows you to post to the red# by HTTP POST request. Below you see an ex [code]curl -ssl -u [color=blue]$E-Mail[/color]:[color=blue]$Password[/color] -d "[color=blue]$Parameters[/color]" [url][observer=1][observer.baseurl][/observer][observer=0]example.com[/observer]/api/statuses/update [/url][/code] -[table][tr][td]$E-Mail:[/td][td]The E-Mail Adress you use to login[/td][/tr] +[table][tr][td]$E-Mail:[/td][td]The E-Mail Address you use to login, or the channel nickname (without the hostname)[/td][/tr] [tr][td]$Password:[/td][td]The Password you use to login[/td][/tr] [tr][td]$Parameters:[/td][td]That's the interesting part, here you insert the content you want to send using the following parameters:[/td][/tr][/table] [ul] [*]title: the title of the posting -[*]channel: the channel you want to post to +[*]channel: the channel you want to post to (do not use this parameter with HTTP Basic auth) [*]category: a comma-seperated list of categories for the posting [*]status: the content of the posting, formatted with BBCode OR [*]htmlstatus:the content of the posting, formatted in HTML. [/ul] +To post to a specific channel, replace the email address with the channel nickname. If you supply the channel parameter, it has to match the "email", but is superfluous anyway. Instead of calling [observer=1][observer.baseurl][/observer][observer=0]example.com[/observer]/api/statuses/update which returns a json (you could also add .json on the end to clarify) output, you can use [observer.baseurl]/api/statuses/update.xml to get an xml formatted return. |