Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dexterlabora/meraki-dashboard-api-express
Meraki Dashboard API Express server with basic Vue JS demo
https://github.com/dexterlabora/meraki-dashboard-api-express
Last synced: 3 months ago
JSON representation
Meraki Dashboard API Express server with basic Vue JS demo
- Host: GitHub
- URL: https://github.com/dexterlabora/meraki-dashboard-api-express
- Owner: dexterlabora
- License: apache-2.0
- Created: 2017-12-21T09:57:27.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-09-02T11:54:10.000Z (over 2 years ago)
- Last Synced: 2024-08-03T01:15:04.175Z (6 months ago)
- Language: HTML
- Size: 406 KB
- Stars: 2
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
- awesome-merakiapis - meraki-dashboard-api-express - Meraki Dashboard API Express server with basic Vue JS demo. (External Captive Portals excap / Contents)
README
# Meraki API Express Server
* Meraki API Request Handler
* Vue.JS sample static HTML page
## Overview
This application provides two core functions, host a website and provide a proxy to the Meraki API.
`public` directory will host any HTML files and supporting assets. A sample **Vue JS** application was written in a single HTML file for demo purposes. Use your own front end framework of choice or build out a professional Vue application.
`server.js` file runs the **express** web server. It proxies the Meraki API requests so that a client browser can interact with the Dashboard API. Doing this directly will result in cross site scripting errors (CORS).
`meraki-request` file is a request wrapper that follows the Meraki API redirects properly.
`configs.js` file stores the API key used by the server. Used as the default API key unless specified by client.
## Install
- Clone this repository and change into the directory,
- Update your API key in the `configs.js` file.
- Install dependencies and run the server.
```
$ npm install
$ node server.js
WWW Server: http://::8085/
Meraki API Client Proxy: http://:::8085/api
Meraki API Endpoint: https://api.meraki.com/api/v0
```
## Usage
### Home Page
http://localhost:8085/
### Meraki API Requests
http://localhost:8085/api
*http://localhost:8085/api/organizations*
## Demo
### Live Demo on Heroku
https://meraki-dashboard-api-express.herokuapp.com/
The Vue application demonstrates how to access the Meraki API endpoints.
Update the **API key** in the **Admin** menu to get started
You typically need to first call the organizations endpoint and then pull the network list before most calls can be made. This demo provides a selector to define these variables, to then be used in a few API requests.
Each endpoint has a button to display the API responses.
By clicking on the API links provided, you can use the server defined API key as a standalone proxy. You will need to add your own headers to adjust the API key or it will use the defaults.
