birdback

0.3.1 • Public • Published

node-birdback

nodejs client library for Birdback API

Installation

$ npm install birdback

Javascript API example usage

var Birdback = require('birdback'),
    b = new Birdback({
        consumerId: '<applicationid>',
        consumerSecret: '<applicationsecret>',
    });

b.authenticate(function (err, response, application) {
    "use strict";
    if (err) {
        throw err;
    }
    b.post(application.url + 'profiles/', {{
        first_name: 'John',
        last_name: 'Smith',
        email: 'john.smith@domain.tld',
        card_number: '41111111111111111'
    }}, function (err, response, profiles) {
        console.log(profile);
    });
});

Please refer to API documentation.

CLI example usage

Signin:

$ birdback --authenticate birdback
{
    username: 'birdback',
    type: 'user',
    created_at: '2014-07-29T08:24:13.549995Z',
    company: { name: 'Birdback', slug: 'birdback' },
    updated_at: null,
    email: 'user@birdback.com'
}

Create a new application:

$ birdback post /birdback/apps/ -d name='my new application'
{
    public_key: '300cb9660121db3',
    description: null,
    locale: 'en-GB',
    hooks: { transaction: 'null', card: 'null' },
    created_at: '2014-07-29T09:00:49.572893Z',
    updated_at: null,
    slug: 'my-new-application',
    url: '/birdback/apps/my-new-application/',
    rsa_key: 'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoIND9qXcKXuKiD08f/Qj0NjEL6RoOylVLxTIq2M8uWjai0D+gDHlIrLvNIjvuoyJCrXWof36o5VPGUpa6+gShIINXzbBj2lQga4M0kWMNNGBo71jLC68tiu/Apy33zdzygdQwIWECWIkWteeWrngH0ItawBhSEckrEGc2KaMuwHdBOW4fzJAqiK47tCrdOyKOxWQi4XozDOXeEXyJDNhz6gU3JoRQCY7BDDFisHrNigIMuAIHjYbrPbJCzLY+SpXOQkaUSbn4IWGx8yAvnvDG7Rno/j+yqUQG5n1DLoqWnqC6wEvBzH6JRD5Nb02/ntOPIf5Rp3AgBww6IcV9r0OMQIDAQAB',
    secret_key: 'f97398a34e3e82857e55d5676',
    type: 'application',
    company: { name: 'Birdback', slug: 'birdback' },
    name: 'my new application'
}

Change the base URL:

$ birdback --chroot /birdback/apps/my-new-application/

root changed to: /birdback/apps/my-new-application/

Request application events:

$ birdback get /events/
[
    {
        application: {
            public_key: '300cb9660121db3',
            description: null,
            locale: 'en-GB',
            hooks: { transaction: 'null', card: 'null' },
            created_at: '2014-07-29T09:00:49.572893Z',
            updated_at: null,
            slug: 'my-new-application',
            url: '/birdback/apps/my-new-application/',
            rsa_key: 'MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoIND9qXcKXuKiD08f/Qj0NjEL6RoOylVLxTIq2M8uWjai0D+gDHlIrLvNIjvuoyJCrXWof36o5VPGUpa6+gShIINXzbBj2lQga4M0kWMNNGBo71jLC68tiu/Apy33zdzygdQwIWECWIkWteeWrngH0ItawBhSEckrEGc2KaMuwHdBOW4fzJAqiK47tCrdOyKOxWQi4XozDOXeEXyJDNhz6gU3JoRQCY7BDDFisHrNigIMuAIHjYbrPbJCzLY+SpXOQkaUSbn4IWGx8yAvnvDG7Rno/j+yqUQG5n1DLoqWnqC6wEvBzH6JRD5Nb02/ntOPIf5Rp3AgBww6IcV9r0OMQIDAQAB',
            type: 'application',
            company: { name: 'Birdback', slug: 'birdback' },
            name: 'my new application'
        },
        created_at: '2014-07-29T09:00:49.589416Z',
        verb: 'created',
        type: 'application_event',
        created_by: {
            username: 'birdback',
            url: '/users/birdback/',
            company: { name: 'Birdback', slug: 'birdback' },
            type: 'user'
        }
    }
]

Readme

Keywords

Package Sidebar

Install

npm i birdback

Weekly Downloads

1

Version

0.3.1

License

MIT

Last publish

Collaborators

  • jeanphix