Webpagemakerapi: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
|||
| Line 37: | Line 37: | ||
The API is a two-endpoint HTTP API that accepts (via POST) HTML documents and serves those documents via a short url. The HTML documents are cleaned by [http://pypi.python.org/pypi/bleach Bleach] before being served. | The API is a two-endpoint HTTP API that accepts (via POST) HTML documents and serves those documents via a short url. The HTML documents are cleaned by [http://pypi.python.org/pypi/bleach Bleach] before being served. | ||
= API Methods = | == API Methods == | ||
<table> | <table> | ||
| Line 62: | Line 62: | ||
</tr> | </tr> | ||
</table> | </table> | ||
== Stored Data == | |||
{| class="wikitable" | |||
|- | |||
! What | |||
! Where | |||
|- | |||
| End-User Created HTML Documents | |||
| In MySQL | |||
|} | |||
Revision as of 18:56, 18 April 2012
Document Overview
| Feature/Product: | [WebPageMaker for Summer Campaign] |
| Projected Freeze Date: | <Placeholder> |
| Product Champions: | Simon Wex, David Ascher |
| Privacy Champions: | |
| Security Contact: | |
| Document State: |
Timeline
| WebPageMaker Checkpoint #2 | All production issues (scalability, privacy standards, etc.) have been resolved. | 20-May-2012 (*soon*) |
Introduction to WebPageMakerAPI's Client -- WebPageMaker
WebPageMakerAPI is a simple API used for persisting and sharing HTML documents by the WebPageMaker Gallery. Building on what's been started with LoveBomb and StoryThing, the Web Page Maker app is designed to let people:
- Go to make.mozilla.org and make a web page fast.
- Share what you make in a low friction way (ie. don't need your own hosting).
- Make something nice based on one of our beautiful remixable templates.
- Learn web literacy skills by making things following our step-by-step guided learning experiences (which are themselves hackable webpages).
- Easily make a new guided learning experience.
For more information on WebPageMaker, see WebPageMaker for Summer Campaign
WebPageMakerAPI Overview
The API is a two-endpoint HTTP API that accepts (via POST) HTML documents and serves those documents via a short url. The HTML documents are cleaned by Bleach before being served.
API Methods
| Name | Endpoint | HTTP Method | Parameters | Return |
| Create Page | /page | POST | Raw Post Data (HTML) | Relative Short URL id (eg. "/ja5bn") |
| Read Page | /{short url id} | GET | short url id (in path) | Sanitized (Bleach) |
Stored Data
| What | Where |
|---|---|
| End-User Created HTML Documents | In MySQL |