voog

Voog.js

NodeJS wrapper for the Voog API, based on the Ruby gem.

Learn more at the Voog developer central and by reading the Voog API documentation.

Getting started

First, you have to install the Voog module to your project directory via npm install voog. Alternatively you can add the 'voog' package to your package.json as a dependency and let npm install do all the work.

API token

To generate your personal API token for your site, go to Account -> My profile and click on "Generate new API token".

Initializing the client

After you have installed the module, you can start using it in your Gruntfile or other script files.

var Voog = require('voog');
var client = new Voog(
    'example.com',                     // site url
    'afcf30182aecfc8155d390d7d4552d14' // API token
);

Using the client

Now, the client is all set up and you can access virtually all resources by just calling the correct methods.

For example, we want to fetch a specific language with the id of 1 and display it:

client.language(1, {}, function(error, language) {
    console.log(language);
});

This displays the Language as an object:

{ 
    id: 1, 
    code: 'en', 
    title: 'ENG', 
        created_at: '2014-07-08T22:12:35.000Z',
    updated_at: '2014-07-08T22:13:18.000Z',
    position: 1,
    default_language: false,
    site_title: 'My new site',
    url: 'http://example.com/admin/api/languages/1',
    move_url: 'http://example.com/admin/api/languages/1/move',
    pages_url: 'http://example.com/admin/api/pages?language_id=1' 
}

We can see that its title attribute is "ENG". Let's change it to something more verbose:

client.updateLanguage(1, {title: 'English'}, function(error, language) {
    console.log(language.title);
});

This displays:

'English'

To see what other methods are available, see the API documentation and browse the code of this module - all methods follow the same principles and should be fairly simple to follow.