dribbble-oauth2 v1.2.0

Dribble-OAUTH2

Library to easy access and use dribbble OAuth2 api.

Getting Started

const settings = {
  'client_id': YOUR_CLIENT_ID,
  'client_secret': YOUR_CLIENT_SECRET
};
const dribble = require('./dribbble-oauth2/index')(settings); // return instance of dribble (singleton)

Dribbble instance can init later. Just call setSettings mehtod/

const dribble = require('dribbble-oauth2')();
// ... another code 
    const settings = {
        'client_id': YOUR_CLIENT_ID,
        'client_secret': YOUR_CLIENT_SECRET
  };
  dribble.setSettings(settings);

  const url = dribble.authorize(REDIRECT_URL, 'public+upload');

Init dribble and set local url when you will get code (note, redirect url should be save in a dribble account)

Scope can be 'public', 'upload' or 'public+upload';

const url = dribble.authorize(redirectUrl, scope); // return link (type = string);

Go to link returned from the authorize method and login into Dribbble using your credentials. After this you will be redirected to the setted url. Use code in params and get the access_token.

app.get('/redirect', (req, res) => {     // Example route
  const code = req.query.code;           // Get the code from url params

  dribble.getToken(code)                    
    .then(response => {
      if (response.status) {                
        res.json(response.statusText)
      } else {
        res.json(response)               // Contains an access_token which you can use in future requests
      }                                     
    });
});

Use predefined access_token

const dribble = DribbleOauth()();
dribble.setAccessToken(ACCESS_TOKEN);

API

Shots

Get all shots

dribble.api.shot.getAll();

Get shot by id

dribble.api.shot.get(id);   

Create a shot

The authenticated user must either be a member of the team or be authenticated as the same team.

dribble.api.shot.create(settings);

Update a shot

dribble.api.shot.update(id, settings);

Delete shot by id

dribble.api.shot.delete(id);   

User

Get the authenticated user

dribble.api.user.get();   

Projects

List projects

dribble.api.project.getAll();   

Create a project

dribble.api.project.create(settings);   

Update a project

dribble.api.project.update(id, settings);   

Delete a project

dribble.api.user.delete(id);   

Attachments

Create an attachment

dribble.api.attachment.create(shotId, settings);   

Delete an attachment

dribble.api.attachment.delete(shotId, attachmentId);