https://github.com/vadym-vorobel/bright-local-api

NodeJS wrapper for BrightLocal API
https://github.com/vadym-vorobel/bright-local-api

api brightlocal javascript nodejs

Last synced: 4 months ago
JSON representation

NodeJS wrapper for BrightLocal API

• Host: GitHub
• URL: https://github.com/vadym-vorobel/bright-local-api
• Owner: vadym-vorobel
• Created: 2017-02-26T19:47:19.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2023-03-03T08:00:47.000Z (almost 2 years ago)
• Last Synced: 2024-10-07T09:11:09.343Z (4 months ago)
• Topics: api, brightlocal, javascript, nodejs
• Language: JavaScript
• Size: 162 KB
• Stars: 3
• Watchers: 0
• Forks: 3
• Open Issues: 4
• Metadata Files:
  • Readme: README.MD

Awesome Lists containing this project

README

        
# 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](https://github.com/BrightLocal/BrightLocal-API-Helper).

## Installation

`npm i -S bright-local-api`

## Examples

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

```js

// ES5

var BrightLocal = require('bright-local-api');

var Api = BrightLocal.Api;

var BatchApiV4 = BrightLocal.V4;

````

```js

// ES6

import { Api, V4: BatchApiV4 } from 'bright-local-api';

```

```js

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:

```js

const batchApi = new BatchApiV4(api);

batchApi.create()

  .then((batchId) => {

    // do what you need with batchId

  });

```

For more details visit [BrightLocal API Documentation page](http://apidocs.brightlocal.com/).