planbox / planbox_api_sandbox Goto Github PK

Single Application Sandbox for Planbox API

planbox_api_sandbox's Introduction

PLANBOX API SANDBOX
-------------------
A single-page-application you can load in your Browser to access the Planbox API.
Calls the Planbox REST API using JSONP (jQuery's getJSON) to avoid cross domain issues.

REQUIREMENTS
- A Planbox account. You can get one for Free here: https://www.planbox.com/signup/pricing.
- A Web Browser like Firefox or Chrome.

HOW TO USE?
- Load the planbox_api_sandbox.html file in your favorite Web Browser.
- Log in to Planbox (if not already).
- Comes with 3 buttons to call the API and dump a report:
  - My Products: Loads all your initiatives
  - My Projects: Loads all projects across all your initiatives
  - My Stories: Loads all stories across all your initiatives

WHAT CAN I DO WITH THIS?
- Learn how to use the Planbox API
- Develop your own SCRUM User Interface (using the Planbox engine and database)
- Create custom reports and functionality
- Create yourself dashboard
- Create a Kanban board

HOW TO CUSTOMIZE?
- Edit the planbox_api_sandbox.html file with your favorite editor.
- Modify the second inline <SCRIPT> tag to add your own functions.
- Use the helper function Planbox.api to call Planbox.
- Use jQuery to handle DOM elements.

Author: Martin Drapeau
Copyright 2009-2012 Planbox Inc.
License: MIT License (http://en.wikipedia.org/wiki/MIT_License)

planbox_api_sandbox's People

Stargazers

Watchers

Forkers

kiritharan

planbox_api_sandbox's Issues

Example code to get resource

I was wondering if you could provide an example jQuery snippet that would be used to grab the products. I've been fiddling with the code in this repo, my own version of it as well as cURLing the the API and I can't seem to come up with the magical combination of access_token, username, password, email, GET/POST, etc.

Here is the closest thing I can (taken from this repo)

        window.Planbox = {

        // Url to Planbox. You can use https if you like.
        base_url: 'https://acceess_token_as_username:[email protected]/',

        // Call the Planbox API
        api: function(fname, args, onsuccess, onerror) {
            var url = Planbox.base_url+'api/'+fname+'?callback=?';
            args = args || {};
            //args = { product_id: "123456778", email: "[email protected]" };

            return $.post(url, args, function(data) {
                if (data && data.code == 'ok') {
                    if (onsuccess) onsuccess(data.content);
                } else if (data && data.code == 'error') {
                    if (onerror) onerror(data.content);
                } else {
                    if (onerror) onerror('Cannot reach Planbox');
                }
            }, "json");
        },

I'm just very confused about the using POST when the intention is to return data and not submit anything. Any clarification would be amazing.

planbox / planbox_api_sandbox Goto Github PK

planbox_api_sandbox's Introduction

planbox_api_sandbox's People

Stargazers

Watchers

Forkers

planbox_api_sandbox's Issues

Example code to get resource

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

Jobs