https://github.com/tejashah88/node-meraki-dashboard

A modern node.js client library for using the Meraki Dashboard API.
https://github.com/tejashah88/node-meraki-dashboard

cisco cisco-meraki client-library dashboard-api meraki meraki-dashboard nodejs

Last synced: about 2 months ago
JSON representation

A modern node.js client library for using the Meraki Dashboard API.

• Host: GitHub
• URL: https://github.com/tejashah88/node-meraki-dashboard
• Owner: tejashah88
• License: mit
• Created: 2017-10-11T06:23:22.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T18:22:16.000Z (over 1 year ago)
• Last Synced: 2024-07-11T20:48:28.440Z (2 months ago)
• Topics: cisco, cisco-meraki, client-library, dashboard-api, meraki, meraki-dashboard, nodejs
• Language: JavaScript
• Homepage:
• Size: 334 KB
• Stars: 21
• Watchers: 8
• Forks: 4
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-merakiapis - node-meraki-dashboard - A slightly opinionated node.js client library for using the Meraki Dashboard API. (Dashboards / Contents)

README

        
# node-meraki-dashboard

[![NPM Version](https://img.shields.io/npm/v/node-meraki-dashboard.svg)](https://www.npmjs.com/package/node-meraki-dashboard)

[![Build Status](https://travis-ci.org/tejashah88/node-meraki-dashboard.svg?branch=master)](https://travis-ci.org/tejashah88/node-meraki-dashboard)

[![Coverage Status](https://coveralls.io/repos/github/tejashah88/node-meraki-dashboard/badge.svg)](https://coveralls.io/github/tejashah88/node-meraki-dashboard)

A modern node.js client library for using the Meraki Dashboard API. Supports a minimum of node v6.

## Documentation

* [Official Documentation](https://api.meraki.com/api_docs)

* [Postman Documentation](https://documenter.getpostman.com/view/897512/2To9xm)

* [Library docs](DOCUMENTATION.md)

## Getting started

### Installing

```bash

npm install --save node-meraki-dashboard

```

### Using Promises

```javascript

const dashboard = require('node-meraki-dashboard')(apiKey);

dashboard.organizations.list()

  .then(data => console.log(data))

  .catch(error => console.log(error));

```

### Using Async/Await

```javascript

const dashboard = require('node-meraki-dashboard')(apiKey);

(async function() {

  try {

    const orgList = await dashboard.organizations.list();

    console.log(orgList);

  } catch (error) {

    console.log(error);

  }

})();

```

## Development / Contributing

See the [CONTRIBUTING](CONTRIBUTING.md) guide for getting started with making modifications to this library.

### Setup & Testing

```bash

git clone https://github.com/tejashah88/node-meraki-dashboard.git

cd node-meraki-dashboard

npm install

npm test

```

### API coverage tool

The API coverage tool is used for reporting endpoints that are not implemented by this library. It fetches the endpoints from the official documentation and checks against the current codebase and finally generates a fancy table of the missing endpoints needed.

#### Usage

```bash

npm run api-coverage

```