Untitled

API design

define your CRUD, or at least the most important parts

example result

Create URL

createURL(api_dev_key, original_url, custom_alias=None, user_name=None, expiry_date=None)

Parameters	type	description
api_dev_key	string	API developer key. e.g. to throttle users based on their quota
original_url	string	the original URL
custom_alias	string	optional custom name for URL
user_name	string	optional user name, e.g. for encoding or url path
expiry_date	string	optional expiration date for shortened URL

Returns	event	type	description
shortened URL	success	string	the URL to be shared by users (end result)
error code	error	Error object	error code and message

Delete URL

deleteURL(api_dev_key, url_key)

Parameters	type	description
api_dev_key	string	Api developer key
url_key	string	the shortened URL to be deleted

Returns	event	type	description
"Url Removed"	success	string	message indicating success
error code	error	Error object	error code and message