Epistlee API
Update : This is the documentation about API of version 2. Updated documentation is coming soon for version 3 of Epistlee.
Epistlee uses HTTP web standards for interaction. It's a RESTful API.
For requests that requires authentication, you need to pass the request with Username and Password inside the Authorization header (i.e. by using Basic Authentication).
For requests that does NOT require authentication, you NEED to pass on the Username inside the Authorization header. You do NOT need to supply the Password.
Each request should be made to http://api.epistlee.com with the request query r. For example, if you want to get the entries then you need to send a request like...
http://api.epistlee.com/?r=getentries
Side note: You can also have a look at Epistlee's PHP Library if you are just looking to implement your Epistlee blog on your website.
Response will be in JSON format.
Below is the reference to the Epistlee API.
Create a Blog
New Blog Entry
Update Blog Entry
Get Blog Entries
Get Blog Entry
Delete Blog Entry
Get User Information
Update User Information
Create a Blog
url: http://api.epistlee.com/?r=register
method: POST
POST parameters: username, password, email
optional: site_title, name
If successful, then a 201 response will be returned. Else an 4xx Error.
New Blog Entry
requires authentication
url: http://api.epistlee.com/?r=new
method: POST
POST parameters: content
NOTE: The first line of content is ALWAYS the blog post title.
If successful, then a 200 response will be returned. Else an 4xx Error.
Update Blog Entry
requires authentication
url: http://api.epistlee.com/?r=update&id=BlogPostID
method: POST
POST parameters: content
NOTE: Do remember to supply the blog post ID in the request URL.
If successful, then a 200 response will be returned. Else an 4xx Error.
Get Blog Entries
This will return the latest 10 entries
requires username in header
url: http://api.epistlee.com/?r=getentries
method: GET
You can optionally send a request specifying a particular page. For example if you want to return the blog entries from page number 3, then you will send a request like below...
url: http://api.epistlee.com/?r=getentries&p=3
If you want raw (non-parsed, preserving the Markdown elements) entries, then you can send request to getuserentries instead. But please note, this requires authentication. Example,
url: http://api.epistlee.com/?r=getuserentries&p=3 Getting just the titles
You also have an option of getting just the titles of blog post, instead of the whole entries. To do this you need to send a request of gettitles instead.
url: http://api.epistlee.com/?r=gettitles&p=3
If successful, then a 200 response will be returned. Else an 4xx Error.
Get Entry
Get a particular blog post. You have two options for getting a blog post entry. One will return raw (i.e. non-parsed, preserving Markdown elements) entry. Other one will return parsed output.
If you want the raw entry, then send a request with id query in the URL.
url: http://api.epistlee.com/?r=entry&id=BlogPostID Else send a request with Base URL of the blog post.
url: http://api.epistlee.com/?r=entry&url=BaseURLofPost After keeping in mind the URL, send the request.
requires username in header
url: http://api.epistlee.com/?r=entry&url=BlogPostBaseURL
url: http://api.epistlee.com/?r=entry&id=BlogPostID
method: GET
If successful, then a 200 response will be returned. Else an 4xx Error.
Delete Blog Entry
requires authentication
url: http://api.epistlee.com/?r=entry&id=BlogPostID
method: DELETE
If successful, then a 200 response will be returned. Else an 4xx Error.
Get User Information
This will return user's name and site title. But you have two options. If you want to get user's email ID, then your request requires authentication. Else it will only return with name and site title.
(optional) requires authentication
requires username in the header
url: http://api.epistlee.com/?r=userinfo
method: GET
If successful, then a 200 response will be returned. Else an 4xx Error.
Update User Information
requires authentication
url: http://api.epistlee.com/?r=userinfo
method: POST
(send the one you wish to update) POST parameters: name, email, sitetitle, password
If successful, then a 200 response will be returned. Else an 4xx Error.