Skip to content

Latest commit

 

History

History
106 lines (78 loc) · 1.7 KB

README.md

File metadata and controls

106 lines (78 loc) · 1.7 KB

node-asana-api

A node.js client implementation for Asana API.

Usage

  var asana = require('asana-api');

  var client = asana.createClient({
    apiKey: 'your-secret-api-key'
  });

  client.users.list(function (err, users) {
    //
    // List all users for this Asana account.
    //
    console.dir(users);
  });

Alternatively create the client with an OAuth token

  var asana = require('asana-api');
  
  var client = asana.createClient({
    token: 'your-oauth-token'
  });
  
  client.users.list(function (err, users) {
    //
    // List all users for this Asana account.
    //
    console.dir(users);
  });

API Coverage

Implemented

  GET /users
  GET /users/me
  GET /users/:user-id

  GET /workspaces
  GET /workspaces/:workspace-id/tasks

  POST /tasks
  GET /tasks
  GET /tasks/:task-id

  GET /projects
  GET /projects/:project-id/tasks

  POST /tags
  GET /tags
  GET /tags/:tag-id
  PUT /tags/:tag-id
  GET /tags/:tag-id/tasks

Not Implemented

  PUT  /tasks/:task-id
  GET  /tasks/:task-id/stories
  POST /tasks/:task-id/stories
  GET  /tasks/:task-id/projects
  POST /tasks/:task-id/addProject
  POST /tasks/:task-id/removeProject

  GET /projects/:project-id
  PUT /projects/:project-id

  GET /stories/:story-id

  PUT  /workspaces/:workspace-id
  POST /workspaces/:workspace-id/tasks
  GET  /workspaces/:workspace-id/projects
  GET  /workspaces/:workspace-id/users

Installation

Installing npm (node package manager)

  curl http://npmjs.org/install.sh | sh

Installing node-asana-api

  [sudo] npm install asana-api

Run Tests

  $ npm test