Overview¶
The API consists of a set of callable methods with a single endpoint.
To perform an action using the API you need to send a request to the endpoint specifying a method and some arguments, and will receive a formatted response.
The REQUIRED parameter Method
is used to specify the calling method.
The REQUIRED parameters APIKey
and Signature
are used to authenticate your account.
The REQUIRED parameter Version
is used to determine which API version to use (currently only version 0.1)
The optional parameter ResponseType
is used to specifiy a response format.
If your account is a master/reseller account, the REQUIRED parameter UserId
is used to determine which account under your account to call the method on.
As an account holder, you can create your key/signature pair via the “edit profile” page. These values are essentially account passwords that must be kept secret from the public. If you do not plan to use this API, make sure to delete your key/signature pair from the system - you can always recreate it later.
Endpoint¶
Example Method Call (GetTitles)¶
Dates¶
All dates throughout the API are configured as yyyy-mm-dd hh:mm:ss
i.e. August 24th, 2014 at 6:49 PM would be represented as 2014-08-24 18:49:00
Terminology¶
Please note that although you’re familiar with the terminology of Hub “Streams”, throughout the API, Streams will be referred to as “Collections”.
Similarly, “Folders” and “Flipbooks”, will be referred to as “Titles” and “Issues” respectively.
Method Call Limit¶
Each API Key/Signature pair is limited to a per hour restriction. Per hour calls are limited to 750.