Differences between revisions 1 and 2
⇤ ← Revision 1 as of 2010-07-12 17:40:59 →
Size: 1476
Editor: cpe-75-80-141-237
Comment:
← Revision 2 as of 2010-07-12 17:41:58 → ⇥
Size: 1501
Editor: cpe-75-80-141-237
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
<<TableOfContents()>>

Contents

  1. UploadBooth API Documentation
    1. Authentication
      1. Client Request Header
      2. How to form the Authorization request
      3. Methods

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

   1 require 'base64'
   2 encoded_string = Base64.encode64('victori:mypassword')
   3 p "Basic Auth #{encoded_string}"

Methods

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

REST API Methods


UploadBooth_API_Documentation (last edited 2010-07-12 19:51:33 by localhost)