## page was renamed from UploadBooth API Documentation
== UploadBooth API Documentation ==

<<TableOfContents()>>

[[http://uploadbooth.com/|UploadBooth]] exposes its data via an [[http://en.wikipedia.org/wiki/Application_programming_interface| Application Programming Interface]] (API). This document is the official reference for that functionality.

=== Authentication ===
[[http://en.wikipedia.org/wiki/Basic_access_authentication|Basic Authentication]] sends user credentials in the header of the HTTP request. This makes it easy to use, but insecure and difficult to track. Basic Authentication is the preferred authentication at this point. I would like to follow the [[http://en.wikipedia.org/wiki/KISS_principle|KISS]] principle on this. 

==== Client Request Header ====
{{{#!wiki note
 GET /delete/some_batch/file1 HTTP/1.1<<BR>>
 Host: localhost<<BR>>
 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==<<BR>>
}}}

==== How to form the Authorization request ====
{{{#!highlight ruby
require 'base64'
encoded_string = Base64.encode64('victori:mypassword')
p "Basic Auth #{encoded_string}"
}}}

==== Methods ====
 The API supports the following methods to send and receive UploadBooth data.

'''REST API Methods'''

 .'''Public Methods'''
 .[[api/authenticate]]
 .[[api/info]]
 .[[api/list]]
 .[[api/check_batch_password]]

 .'''Authorized Methods'''
 .[[api/delete]]
 .[[api/rename]]
 .[[api/edit]]

<<BR>>

 * [[API_HTTP_Response_Codes_and_Errors|API HTTP Response Codes and Errors]]
 * [[API_Terms_of_Service|API Terms of Service]]
 * [[API_Code_Samples|API Terms of Service]]