Skip to content

Latest commit

 

History

History
123 lines (93 loc) · 4.65 KB

REST_API.markdown

File metadata and controls

123 lines (93 loc) · 4.65 KB

The REST API

Overview

At the lowest level, Minus exposes its API with a REST, http-accessible, API. To make it easier for application builders, we will be providing Python, .NET, Ruby, and other API's in the near future.

This file documents the REST API.

The API

We have designed our API to allow you to easily create galleries and upload files programmatically. There are currently 7 API’s published with more to come in the near future. The API is open and no registration is required.

Please subscribe to our http://blog.min.us for any updates regarding our API and contact us if you have any questions.

We have designed our API to allow you to easily create galleries and upload files programmatically. There are currently 7 API’s published with more to come in the near future. The API is open and no registration is required.

Please subscribe to our http://blog.min.us for any updates regarding our API and contact us if you have any questions.

CreateGallery

Description

  • http://min.us/api/CreateGallery
  • creates a gallery on the server side and returns the editor and reader id. The editor id combined with the key can be used to upload images into the gallery.
  • On return, the gallery can be immediately viewed on the web site.

Example

  • A call returns the below HttpResponse. This gallery can be edited in any browser by going to http://min.us/mej0rg. The gallery can be viewed via http://min.us/vodiX5. Response: {"editor_id": "ej0rg", "reader_id": "vodiX5"}

UploadItem

Parameters

Result

You can immediately view this picture in any browser by: http://min.us/icBpkM. Returns: {"id": "cBpkM", "height": 64, "width": 500, "filesize": "1010 bytes"}

Note that you must prefix the id with a /i (if it's an item) or a /m (if it's a gallery) to see access the uploaded item or new gallery.

Example

Note that the editor_id does not have the leading m that is in the page url. curl "http://min.us/api/UploadItem?editor_id=dn48vKBiP3q9&key=OK&filename=min.png" -F "file=@min.png" http://min.us/mvwUFP#1

SaveGallery

  • http://min.us/api/SaveGallery
  • Use this to update the gallery name or change sort order.
  • application/x-www-form-urlencoded
  • items=%5B%22A1Q%22%5D&name=test2&key=OK&id=bgZrGCaapOSL2
  • items is a json encoded list of the gallery items: {"A1Q", "B1Q"} Example working Python code:

::

import httplib, urllib, urllib2, json
params = {"name":"test2","id":"bgZrGCaapOSL2","key":"OK","items":json.dumps(["A1Q"])}
encoded = urllib.urlencode(params)
f = urllib2.urlopen('http://min.us/api/SaveGallery ', encoded)

GetItems

Example: http://min.us/api/GetItems/mvgkRZC returns: ::

{
    "READ_ONLY_URL_FOR_GALLERY": "http://min.us/mvgkRZC", 
    "GALLERY_TITLE": "Untitled", 
    "ITEMS_GALLERY": [
         "http://i.min.us/jb0oQi", 
         "http://i.min.us/jb0Aj2", 
         "http://i.min.us/jdLnSy", 
         "http://i.min.us/jdH3Au", 
         "http://i.min.us/jdLqa6"
     ]
}

SignIn

  • http://min.us/api/SignIn
  • Use this to sign in a user and get a cookie to use to add galleries to the user's "My Galleries" page.
  • POST request type, parameters are username and password1, with the already registered username and password for the user.
  • The reply is a json of a dictionary with a key you should check: "success": True/False. Other values in the dictionary give error information telling the user about invalid username, password, or username-password combination.
  • Retain cookie to place subsequent visited or created galleries in the user's "My Galleries" page.

SignOut

My Galleries

  • http://min.us/api/MyGalleries.json
  • GET request. No params.
  • Exposes My Galleries page as a convenient json call.
  • If the edit url is not available, instead of starting with 'm', it will be "Unavailable". If the gallery has been deleted, the value is "Deleted".

JSON formatted list:

{
	"galleries": [
	{ "last_visit": "7 minutes ago", "name": "test", "item_count": 1, "clicks": 4, "reader_id": "vgkRZC", "editor_id": "bgZrGCaapOSL2" },
	{ "last_visit": "5 hours ago", "name": "test2", "item_count": 1, "clicks": 0, "reader_id": "vgkRZB", "editor_id": "bgZrGCaapOSL1" } 
	]
}