|
|
Line 39: |
Line 39: |
| == API Methods == | | == API Methods == |
|
| |
|
| These are all anonymous calls -- no auth is needed. | | These are documented in the [https://github.com/mozilla/webpagemaker/tree/development/webpagemaker/api#readme API README]. |
| | |
| <table>
| |
| <tr>
| |
| <td>Name</td>
| |
| <td>Endpoint</td>
| |
| <td>HTTP Method</td>
| |
| <td>Parameters</td>
| |
| <td>Return</td>
| |
| </tr>
| |
| <tr>
| |
| <td>Create Page</td>
| |
| <td>/page</td>
| |
| <td>POST</td>
| |
| <td>Raw Post Data (HTML)</td>
| |
| <td>Relative Short URL KEY id (eg. "ja5bn") which can be appended to the app index (eg. "http://webpagemakerapi.vcap.mozillalabs.com/ja5bn")</td>
| |
| </tr>
| |
| <tr>
| |
| <td>Read Page</td>
| |
| <td>/{short url id}</td>
| |
| <td>GET</td>
| |
| <td>short url id (in path)</td>
| |
| <td>Sanitized ([http://pypi.python.org/pypi/bleach Bleach])</td>
| |
| </tr>
| |
| </table>
| |
|
| |
|
| == Stored Data == | | == Stored Data == |