storyblocks-api

Storyblocks API (Version 2)

Storyblocks API wrapper for node.js

Installation

This module is installed via npm:

$ npm install storyblocks-api

API

Create the authorised API service you need (audioblocks or videoblocks).

const credentials = {
  privateKey: '...',
  publicKey: '...'
};
const { audioblocks, videoblocks } = require('storyblocks-api')(credentials);

Then start making your requests to Storyblocks

const params = {
  keywords: 'mountain aerial',
  page: 1,
  numResults: 5
};
const search = await videoblocks.search(params);
// search = { results: [...], totalResults: 4652 };

Parameters

The parameters argument combines both the URI parameters and the Query parameters shown in the docs.

All parameter keys can be defined in camel case to be consistent with code styling practices. All keys will be converted back to snake case for the acutal request to Storyblocks.

Response

Response objects also have their keys converted back to camel case (from the mostly, but not entirely, snake case values returned from Storyblocks).

Audioblocks

Search Audio

const results = await audioblocks.search(params);

For a list of parameters see the docs.

List Categories

const results = await audioblocks.categories(params);

For a list of parameters see the docs.

Get Audio Details

const results = await audioblocks.audio(params);

For a list of parameters see the docs.

Get Similar Audio

const results = await audioblocks.similar(params);

For a list of parameters see the docs.

Download Audio

const results = await audioblocks.download(params);

For a list of parameters see the docs.

List Collections

const results = await audioblocks.collections(params);

For a list of parameters see the docs.

Get Collections

const results = await audioblocks.collection(params);

For a list of parameters see the docs.

Videoblocks

Search Videos

const results = await videoblocks.search(params);

For a list of parameters see the docs.

List Categories

const results = await videoblocks.categories(params);

For a list of parameters see the docs

Get Video Details

const results = await videoblocks.video(params);

For a list of parameters see the docs.

Get Similar Videos

const results = await videoblocks.similar(params);

For a list of parameters see the docs.

Download Video

const results = await videoblocks.download(params);

For a list of parameters see the docs.

List Collections

const results = await videoblocks.collections(params);

For a list of parameters see the docs.

Get Collections

const results = await videoblocks.collection(params);

For a list of parameters see the docs.

Tests

Some tests use nock.back. These are tests that will record network traffic the first time they are run and then use those recordings as fixtures for subsequent runs.

When recording tests a valid storyblocks private and public key is required. These are set using the STORYBLOCKS_PRIVATE_KEY and STORYBLOCKS_PUBLIC_KEY environment variables. The simplest way to do this is with a .env file which will be automatically loaded by the nock.back tests. Note that .env files have been added to the .gitignore so they are never committed.

Fixtures are stored in /test/fixtures. If you need to re-record a test the simplest way is to just remove the recorded fixture and run the tests again.

License

The BSD License

Copyright (c) 2019, Andrew Harris

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of the Andrew Harris nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.