Nobody Pays (for) Magazines

    bright-local-api

    0.0.8 • Public • Published

    NodeJS BrightLocal API

    A basic NodeJS wrapper to make using the BrightLocal API a little easier. It takes care of authentication so you just need to specify which method you want to call and pass parameters. Based on BrightLocal PHP wrapper.

    Installation

    npm i -S bright-local-api

    Examples

    You need to export Api and V4 (for batch requests) classes at first.

    // ES5
    var BrightLocal = require('bright-local-api');
    var Api = BrightLocal.Api;
    var BatchApiV4 = BrightLocal.V4;
    // ES6
    import { Api, V4BatchApiV4 } from 'bright-local-api';
    const api = new Api(API_KEY, API_SECRET);
     
    // create a client
    api.post('/v1/clients-and-locations/clients/', { name: '...', ... });
     
    // also you can write
    api.call('/v1/clients-and-locations/clients/', { name: '...', ... }, 'post');
     

    The same thing you can do with other methods like put, get and delete.

    *note Api#call, Api#get, Api#post, Api#put, Api#delete returns a Promise.

    If you want to make a batch request:

    const batchApi = new BatchApiV4(api);
     
    batchApi.create()
      .then((batchId) => {
        // do what you need with batchId
      });

    For more details visit BrightLocal API Documentation page.

    Install

    npm i bright-local-api

    DownloadsWeekly Downloads

    56

    Version

    0.0.8

    License

    ISC

    Unpacked Size

    20.9 kB

    Total Files

    11

    Last publish

    Collaborators

    • alonoslav