Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Update README.md

  • Loading branch information...
commit e983df8dfebaf1ceabc95093a5d51adb9aa5962a 1 parent 66a6be9
Jeff Zellner authored April 03, 2012

Showing 1 changed file with 21 additions and 12 deletions. Show diff stats Hide diff stats

  1. 33  README.md
33  README.md
Source Rendered
@@ -4,6 +4,12 @@ Details here: https://github.com/canvasnetworks/api/wiki
4 4
 
5 5
 Public API
6 6
 ===
  7
+Mailing list
  8
+---
  9
+You can keep up to date with API announcements and discussion via the Canvas Public API Google Group: https://groups.google.com/group/canvas-public-api
  10
+
  11
+Code examples
  12
+---
7 13
 See: api_example.py
8 14
 
9 15
 Root
@@ -23,12 +29,12 @@ Posts endpoint of the canv.as public api
23 29
 
24 30
 Request with an id parameter:
25 31
 
26  
-/public_api/posts/1qkx8
  32
+    /public_api/posts/1qkx8
27 33
 
28 34
 POST JSON in the following format:
29 35
 
30  
-POST /public_api/posts/
31  
-{"ids":["1qkx8","ma6fz"]}
  36
+    POST /public_api/posts/
  37
+    {"ids":["1qkx8","ma6fz"]}
32 38
 
33 39
 Users
34 40
 ---
@@ -36,29 +42,32 @@ Users endpoint of the canv.as public api
36 42
 
37 43
 Request with an id parameter:
38 44
 
39  
-/public_api/users/watermelonbot
  45
+    /public_api/users/watermelonbot
40 46
 
41 47
 POST JSON in the following format:
42 48
 
43  
-/public_api/users/
44  
-{"ids":["watermelonbot", "jeff"]}
  49
+    POST /public_api/users/
  50
+    {"ids":["watermelonbot", "jeff"]}
45 51
 
46 52
 User posts will be returned in pages, ordered newest to oldest. You can request posts beyond the initial range by POSTing JSON in the following format:
47 53
 
48  
-/public_api/users/
49  
-{"ids":[{"user":"watermelonbot","skip":100},"jeff"}
  54
+    POST /public_api/users/
  55
+    {"ids":[{"user":"watermelonbot","skip":100},"jeff"}
50 56
 
51 57
 Groups
52 58
 ---
53 59
 Groups endpoint of the canv.as public api
54 60
 
55 61
 Request with an id parameter:
56  
-/public_api/groups/funny
  62
+
  63
+    /public_api/groups/funny
57 64
 
58 65
 POST JSON in the following format:
59  
-{"ids":["funny","canvas"]}
  66
+
  67
+    POST /public_api/groups/
  68
+    {"ids":["funny","canvas"]}
60 69
 
61 70
 Group posts will be returned in pages, ordered newest to oldest. You can request posts beyond the initial range by POSTing JSON in the following format:
62 71
 
63  
-/public_api/groups/
64  
-{"ids":[{"group":"funny","skip":100},"canvas"}
  72
+    POST /public_api/groups/
  73
+    {"ids":[{"group":"funny","skip":100},"canvas"}

0 notes on commit e983df8

Please sign in to comment.
Something went wrong with that request. Please try again.