Authentication
The API requires a key.
If you would like to make use of the API contact us to request a key.
Usertoken API
Get Usertoken API endpoint
Get Usertoken API endpoint
http://anotherread.com/site/api/user/json/v1/get-api-key/default.aspx
For endpoints which require a logged in user, account validation is provided through checks against a supplied usertoken which has a limited lifespan. The Get Usertoken API Endpoint requires the following parameters in a POST Request:
Example query
Example query
var dataToSend = { username: "user", password: "1234" };
return $.ajax({
type: "POST",
url: "http://anotherread.com/api/user/json/v1/get-api-key/default.aspx",
dataType: "json",
traditional: true,
data: jQuery.param(dataToSend)
});
Account API
Register API endpoint
Get Usertoken API endpoint
http://anotherread.com/site/read/templates/api/account/json/v1/register/default.aspx
The Register API Endpoint requires the following parameters in a POST Request:
Example query
Example query
var dataToSend = { email: "[email protected]", receiveAlerts: true
return $.ajax({
type: "POST",
url: "http://anotherread.com/site/read/templates/api/account/json/v1/register/default.aspx",
dataType: "json",
traditional: true,
data: dataToSend
});
Activity API
Activity API endpoint
Activity API endpoint
http://anotherread.com/site/read/templates/activityfeedapi.aspx?cc=gb&action=activities
The API Endpoint can be queried using the following URL parameters in a GET Request:
- contributors
- publishers
- imprint
- keywords
- quantityOfRecord
- accesskey
Example queries
Example query - 100 activity items matching the keyword of "dog".
Example query
http://anotherread.com/site/read/templates/activityfeedapi.aspx?cc=gb&action=stack&accesskey=XXXXXXXXXXXXXXXX&quantityOfRecord=100&keywords=dog
Example query - 100 activity items matching the keyword of "dog" for the publisher with ID 88.
Example query
http://anotherread.com/site/read/templates/activityfeedapi.aspx?cc=gb&action=stack&accesskey=XXXXXXXXXXXXXXXX&quantityOfRecord=100&keywords=dog&publishers=88
Example query - 100 activity items matching the keyword of "dog" for the contributor with ID 8012.
Example query
http://anotherread.com/site/read/templates/activityfeedapi.aspx?cc=gb&action=stack&accesskey=XXXXXXXXXXXXXXXX&quantityOfRecord=100&keywords=dog&contributors=8012
Output
The API outputs JSON data, and returns:
ActivityID
A unique ID for the activity item.
CreatedByUserID
The ID of the user that created the item as given by Another Read.
ActivityTypeID
The type of activity.
PublisherID
The ID of the publisher as given by Another Read.
BookID
If the activity is associated with a book, the ID of the book as given by Another Read.
ImprintID
The ID of the Imprint as given by Another Read.
AgeTo
The suggested upper age the activity item may be of interest to.
AgeFrom
The suggested lower age the activity item may be of interest to.
Latitude
If the activity item relates to a geographic location such as an event, the latitude of that event.
Longitude
If the activity item relates to a geographic location such as an event, the longitude of that event.
CreatedDate
The date the activity item was created e.g. 2018-01-01T00:00:00.000.
DisplayDate
The date the activity item was set to display from e.g. 2018-01-01T00:00:00.
Text
Text content of the activity item, this can include HTML mark-up.
Keywords
Keywords associated with the activity item.
Title
The title of the activity item.
HashTags
Suggested hashtags associated with the activity item.
PrimaryImageUrl
The URL of an image associated with the activity item.
AvatarImageUrl
The URL of an avatar associated with the activity item e.g. the author of the book.
LinkUrl
The default URL the activity item should link to.
CategoryList
A list of categories associated with the activity item, each entry includes CategoryID, Name, DeletedByUserID, CategoryTypes.
ContributorList
A list of contributors (authors and illustrators) associated with the activity item, each entry includes ContributorID, StateID, UserID, Name, DisplayName, Biography, SmallAvatarImageFileName, StateName.
ActivityWeightPercent
The weighting associated with an activity item as given by Another Read.
Featured
Indicates whether the activity item is flagged to be featured.
Approved
Indicates whether the activity item is approved.
IsPinned
Indicates whether the activity item is currently pinned.
StyleID
An ID indicating which style to use to display the item within Another Read.
PinFromDate
If pinned, the pinned from date.
PinToDate
If pinned, the pinned to date.
ExpiryDate
A date the activity item should expire.
CanEdit
N/A.