andbang

0.2.0 • Public • Published

And Bang API Client

Makes it dead simple to build web apps on the And Bang API.

  • All API functionality becomes a function call.
  • Couldn't be any simpler

Just include the script in your HTML

<script src="andbang.js"></script>

Then write some JS

// init an instance of the API connection
var api = new AndBang();
 
// then log in
api.validateToken('your access token', function (err, yourUser) {
    window.me = yourUser;
});
 
// 'ready' is triggered when you're successfully logged in
api.on('ready', function () {
    // once 'ready' has been triggered 
    // all your normal API functions are available
    // as function calls.
 
    // for example, we can just fetch our teams
    // and pass it a callback.
    api.getMyTeams(function (err, myTeams) {
        window.teams = myTeams;
    });
});

It uses socket.io under the covers so you get realtime, seemless API access that's as easy as AJAX.

Have fun!

Docs

You can see all available API methods on the developer docs: https://developer.andbang.com

andbang.template.js

andbang.js is generated from the provided API specification, spec.json. This allows automation allows for rapid expansion of the API across many platforms.

To generate andbang.js, run the provided build script, which depends on spec.json and andbang.template.js.

node ./build

Readme

Keywords

none

Package Sidebar

Install

npm i andbang

Weekly Downloads

7

Version

0.2.0

License

none

Last publish

Collaborators

  • andyet-ops
  • henrikjoreteg
  • lancestout
  • hjon