THE BRAND REGARD API

USE OUR API TO INTEGRATE BRAND REGARD WITH YOUR OWN TECHNOLOGY OF CHOICE

Following is a description of version 1 of our API. Every request should be a HTTP GET request posted via SSL. As long as "v1" is used in the URL, version 1 of the API will be used which will not change from the below specification. Note that the api_key parameter must be included en every request made to the API.

GETTING STARTED

First you need to generate your API key. This is done at the bottom of the Settings page. Click the "Get a key" link and you're ready to go.

AUTHENTICATION

Authentication is done by supplying your api key as a parameter to every request you make. Remember to always use SSL when interfacing with our API, otherwise someone can listen in an discover what your key is.

curl 'https://[subdomain].brandregard.com/api/v1/toolkits.xml?api_key=[your_key]'

AVAILABLE DATA

The data currently available is:

  • A list of your account's toolkits
  • A list of every asset in a specific toolkit
  • Information on a single asset, including download and image preivew URIs

Note that some assets, such as PDfs, have previews that are image strips, which means they can be animated.

LIST OF TOOLKITS

The URI for the list of toolkits is:

/api/v1/toolkits.xml

The result will look like this:

<toolkits>
  <title>Available Toolkits</title>
  <toolkit>
    <id>[id]</id>
    <name>Audio</name>
    <uri href="https://[subdomain].brandregard.com/api/v1/toolkits/[id]"/>
  </toolkit>
  <toolkit>
    <id>2</id>
    <name>Logo</name>
    <uri href="https://[subdomain].brandregard.com/api/v1/toolkits/[id]"/>
  </toolkit>
</toolkits>

Where [subdomain] and [id] will be replaced by your subdomain and the actual id.

LIST OF ASSETS WITHIN TOOLKIT

The URI to list assets within a toolkit is.

/api/v1/toolkits/[toolkit_id]

The best way to know what id to use to retrieve a toolkit is to get it from the toolkit list, detailed above. The result will look like this:

  <toolkit>
    <title>Web</title>
    <assets>
      <asset>
        <id>[id]</id>
        <name>Large banner</name>
        <uri href="https://[subdomain].brandregard.com/api/v1/assets/[id]"/>
      </asset>
      <asset>
        <id>393</id>
        <name>gmail.png</name>
        <uri href="https://[subdomain].brandregard.com/api/v1/assets/[id]"/>
      </asset>
    </assets>
  </toolkit>


ASSET INFORMATION

The URI to get information about a single asset is:

/api/v1/assets/[asset_id]

And the results look like this:

<asset>
  <id>[id]</id>
  <name>[name of the asset]</name>
  <uri href="https://[subdomain].brandregard.com/api/v1/assets/[id]"/>
  <download-uri href="[download url]"/>
  <previews>
    <tiny-uri href="[30x30 preview url]"/>
    <small-uri href="[75x50 preview url]"/>
    <medium-uri href="[97x65 preview url]"/>
    <large-uri href="[220x150 preview url]"/>
  </previews>
</asset>    
  


There are four available sizes of thumbnails. Note that for SWFs and PDFs, the thumbnails are multiple images lined up in a strip, which allows the animation of previews.

Advantages of web-based software
  • Your data is secure and is backed up daily.
  • Your software is always up to date - no need for software upgrades.
  • You can access the software from any country, any office, on the train or at home.
  • It doesn't matter if you're using a PC, a Mac, Linux or a mobile.
Full browser support
Browsers
Background-footer