jeena/tent.io
1
0
Fork 0
Code Issues Pull requests Projects Packages Wiki Activity Actions

Add authorization to app-server request in docs

Browse source
This commit is contained in:
Jesse Stuart 2012-08-22 14:15:49 -04:00
parent 4112a32252
commit 45a9fc0ad3
1 changed files with 56 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

56
content/docs/app-server.md
View file

@ -13,6 +13,10 @@ Your app, or a third party app your using, will request the profile JSON from yo
``` ```
GET /profile GET /profile
Accept: application/json Accept: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
``` ```
@ -57,6 +61,10 @@ If given permission, an app can update your profile JSON. An app can have permis
PATCH /profile PATCH /profile
Accept: application/json Accept: application/json
Content-Type: application/json Content-Type: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
```json ```json
[ [
@ -129,6 +137,10 @@ App gets list of entities your server is following.
``` ```
GET /following GET /following
Accept: application/json Accept: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
``` ```
@ -164,6 +176,10 @@ App tells server to follow an entitie.
``` ```
POST /following POST /following
Content-Type: application/json Content-Type: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
```json ```json
{ {
@ -186,6 +202,10 @@ App changes what groups are applied to an entity your server is following.
PATCH /following/bda7f416fbba PATCH /following/bda7f416fbba
Accept: application/json Accept: application/json
Content-Type: application/json Content-Type: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
```json ```json
{ {
@ -214,6 +234,10 @@ App tells server not to follow an entity.
``` ```
DELETE /following/bda7f416fbba DELETE /following/bda7f416fbba
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
``` ```
@ -227,6 +251,10 @@ App asks for list of entities that are following the server.
``` ```
GET /followers GET /followers
Accept: application/json Accept: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
``` ```
@ -255,6 +283,10 @@ App tells server to update information about a follower entity.
PATCH /followers/ddd67278456b PATCH /followers/ddd67278456b
Accept: application/json Accept: application/json
Content-Type: application/json Content-Type: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
```json ```json
{ {
@ -287,6 +319,10 @@ App asks for info about specific follower
``` ```
GET /followers/ddd67278456b GET /followers/ddd67278456b
Accept: application/json Accept: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
``` ```
@ -309,6 +345,10 @@ App tells server not to send notifications to entity.
``` ```
DELETE /followers/ddd67278456b DELETE /followers/ddd67278456b
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
``` ```
@ -326,6 +366,10 @@ See [conversation example](https://github.com/tent/tent-docs/blob/master/example
``` ```
POST /posts POST /posts
Content-Type: application/json Content-Type: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
```json ```json
{ {
@ -391,6 +435,10 @@ You want to see it, so your app requests it from your server.
``` ```
GET /posts/3fe1abef41cb?entity=smithson%2Eme&fetch=force GET /posts/3fe1abef41cb?entity=smithson%2Eme&fetch=force
Accept: application/json Accept: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
#### Request Params #### Request Params
@ -435,6 +483,10 @@ For example, your app has a stream view showing status updates from you and your
``` ```
GET https://tent.johnsmith.io/posts?since_id=80b445839dd1&limit=50 GET https://tent.johnsmith.io/posts?since_id=80b445839dd1&limit=50
Accept: application/json Accept: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
#### GET /posts[?params] #### GET /posts[?params]
@ -442,6 +494,10 @@ Accept: application/json
``` ```
GET /posts?fetch=false GET /posts?fetch=false
Accept: application/json Accept: application/json
Authorization: MAC id="775ecf8",
ts="1336363200",
nonce="dj83hs9s",
mac="bhCQXTVyfj5cmA9uKkPFx1zeOXM="
``` ```
#### Request Params #### Request Params