Downloading Assets

Assumptions

Retrieve Originals

downloading assets

Downloading the original file of an asset is a pretty straightforward call. You simply perform: Retrieve asset download location endpoint.

For example:

HTTP Parameter Value
HTTP Method GET
URL https://byndair.getbynder.com/api/v4/media/D4AC0B41-141B-47D2-98B4FECDA8894CB2/download/
Headers Authorization : OAuth version 1.0 generated authorization header

Retrieve Originals and Derivatives

If you are not familiar with the term "derivatives" check out this link.

Derivatives and originals are files that are related to a specific asset and a specific version of it. To find out all the available files of an asset, you should make the retrieve specific asset call with its versions parameter set to 1.

For example, let's say we have the asset with id D4AC0B41-141B-47D2-98B4FECDA8894CB2. Below is the call you should make in order to find all of its available files.

HTTP Parameter Value
HTTP Method GET
URL https://byndair.getbynder.com/api/v4/media/D4AC0B41-141B-47D2-98B4FECDA8894CB2/?versions=1
Headers Authorization : OAuth version 1.0 generated authorization header

The response of this call will include an additional property called mediaItems that will contain a list of all the files of the asset. Here, you can find for every file its version and if that is the active version or not.

{
....
    "mediaItems": [
        {
          "height": 220,
          "version": 1,
          "fileName": "Twitter-1364b483-a8c2-41fa-8feb-b8a797696990.jpg",
          "dateCreated": "2017-03-22T13:40:36Z",
          "size": 21348,
          "width": 440,
          "id": "1364B483-A8C2-41FA-8FEBB8A797696990",
          "thumbnails": {
            "mini": "https://d1ra4hr810e003.cloudfront.net/media/B36D6BF4-75F3-4995-A8D205FFB9E2EABB/D4AC0B41-141B-47D2-98B4FECDA8894CB2/mini-1929192A-8656-4C1F-BEF83FD228AC567B.jpg",
            "webimage": "https://d1ra4hr810e003.cloudfront.net/media/B36D6BF4-75F3-4995-A8D205FFB9E2EABB/D4AC0B41-141B-47D2-98B4FECDA8894CB2/webimage-1B9D10B7-59A5-4B9D-9C381F3AD2442141.jpg",
            "thul": "https://d1ra4hr810e003.cloudfront.net/media/B36D6BF4-75F3-4995-A8D205FFB9E2EABB/D4AC0B41-141B-47D2-98B4FECDA8894CB2/thul-C7E0314E-1530-4DF7-AD165FAA410F74DB.jpg"
          },
          "active": 1,
          "type": "web"
        },
    ]
}

In most cases working with one of the links that is provided in the thumbnails of the mediaItems will suffice.

Nevertheless, sometimes you will be required to retrieve the file itself, if for example you are working with documents, videos, etc. Then you will have to call the retrieve specific asset item download location where you populate the itemId parameter with the id of the specific mediaItem you want.

For example, using the previous response (for the asset with id D4AC0B41-141B-47D2-98B4FECDA8894CB2), we can use the id 1364B483-A8C2-41FA-8FEBB8A797696990 as our itemId parameter.

Below is shown the call we should make in order to retrieve the specific file of that asset.

HTTP Parameter Value
HTTP Method GET
URL https://byndair.getbynder.com/api/v4/media/D4AC0B41-141B-47D2-98B4FECDA8894CB2/download/1364B483-A8C2-41FA-8FEBB8A797696990/
Headers Authorization : OAuth version 1.0 generated authorization header