UploadBooth API Documentation
UploadBooth exposes its data via an Application Programming Interface (API). This document is the official reference for that functionality.
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 KISS principle on this.
Client Request Header
GET /delete/some_batch/file1 HTTP/1.1
Host: localhost
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
How to form the Authorization request
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