Skip to content

Latest commit

 

History

History
39 lines (28 loc) · 1.54 KB

README.md

File metadata and controls

39 lines (28 loc) · 1.54 KB

behance-api

Build Status Coverage Status

Node.js wrapper for the Behance API, see the Behance API docs for more details. In order to use the Behance API you will need to register your application to receive your API key.

Installation

Install package with NPM

npm install behance-api --save

Usage

Making a request looks something like this:

// Dependencies
const Behance = require('behance-api');
const Be = new Behance(API_KEY);

// Get Projects Data
Be.projects({q: 'motorcycle'}, function (err, res, data) {
  if (err) throw err;

  // Do something with the data received from the API
  console.dir(data);
});

The snippet above will make a request to the Behance API and receive the first page of results that match the motorcycle query for the /projects/ endpoint. It then displays that data in the terminal. Every callback gets three arguments; an error (if there is one), the HTTP response, and a JSON object.

API

For documentation around accessing all of the endpoints, see API Docs

License

MIT