On this page and you will (hopefully) find anything you need to know to use our API.
The API is intented for:
The API is currently in beta status. This means that there might occur breaking changes in the API’s design, e.g. renamed parameters or changed URLs. We will do our best to avoid this or keep it to a minimum.
Currently the API is intended only for private use. Api usage terms will be linked here in the future.
This is a free service so please try to not create too much blogs/posts/comments and traffic.
The API is based on REST principles and uses Json as data format. We have some example requests in Python (including the server response) which makes it easy to understand the api and its data structures. Beside this you can use nearly any HTTP client in your favorite programming language to communicate with the API.
| HTTP method | action | HTTP return code on success |
|---|---|---|
| POST | Creates a new resource | 201 (created) |
| GET | Reads a resource | 200 (ok) |
| PUT (POST) | Updates an existing resource | 200 (ok) |
Addtionally to the HTTP return code the json response contains a boolean field "success" whose value is "true". If "success" is "false" a field "error" contains additional information as a string.
ATTENTION:The images are an exception. They are served via the google blobstore and do not contain a "success" field.
| blog (url) | method | description | |
|---|---|---|---|
| /api/blog/v1.0/blog/{blog} | POST | Create new blog with blog-id={blog}. | details |
| /api/blog/v1.0/blog/{blog} | GET | Get details of blog with blog-id={blog}. | details |
| /api/blog/v1.0/blog/{blog} | PUT | Update blog with blog-id={blog}. | details |
| post (url) | method | description | |
| /api/blog/v1.0/blog/{blog}/posts | POST | Create new post for {blog}. On success post-id is returned. | details |
| /api/blog/v1.0/blog/{blog}/posts | GET | List posts of {blog}. | details |
| /api/blog/v1.0/blog/{blog}/posts/{post} | GET | Get details of {post} belonging to {blog}. | details |
| /api/blog/v1.0/blog/{blog}/posts/{post} | PUT (POST) | Update {post} belonging to {blog}. | details |
| comment (url) | method | description | |
| /api/blog/v1.0/blog/{blog}/posts/{post}/comments | POST | Create new comment for {post} (of {blog}). On success comment-id is returned. | details |
| /api/blog/v1.0/blog/{blog}/posts/{post}/comments | GET | List comment of {post} (of {blog}). | details |
| /api/blog/v1.0/blog/{blog}/posts/{post}/comments/{comment} | GET | Get details of {comment} of {post} (belonging to {blog}). | details |
| /api/blog/v1.0/blog/{blog}/posts/{post}/comments/{comment} | PUT (POST) | Update {comment} of {post} (belonging to {blog}). | details |
| images (url) | method | description | |
| /api/blog/v1.0/images/{images} | GET | Get {images} data. | details |