Skip to content

Web Browser extension for Mist Developpers to provide quick access to Mist APIs. The application is analysing the URL of the current tab to provides the org_id, site_id (if any) object_id (if any) and quick access the main API calls for this page. It can also be used to manage and generate User and Org API Token.

License

Notifications You must be signed in to change notification settings

Mist-Automation-Programmability/mist_browser_extension

Repository files navigation

Mist Browser Extension

Browser extension to get easier access to Mist APIs and Mist API Tokens. Supported on Firefox, Chrome / Chromium-based Web browsers.

MIT LICENSE

Copyright (c) 2021 Thomas Munzer

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Features

Supported Mist Clouds:

  • Global 01 (manage.mist.com)
  • Global 02 (manage.gc1.mist.com)
  • Global 03 (manage.ac2.mist.com)
  • Global 04 (manage.gc2.mist.com)
  • EMEA 01 (manage.eu.mist.com)
  • EMEA 02 (manage.gc3.mist.com)
  • APAC 01 (manage.ac5.mist.com)
  • US GOV Cloud (manage.us.mist-federal.com)

API Tab

When on the Mist Dashboard

  • Quick access to the Mist IDs (org_id, site_id and object_id) from the current Mist dashboard page
  • Direct access to the Mist API Pages (Django) from the current Mist dashboard page

When on a Django Page

  • Lists all the available query parameters
  • Allows to easily customize the query parameters
  • Direct access to the Online API Documentation for the current API Call (GET/POST/PUT/DELETE)

Account Tab

  • List all the current valid Mist session in the web browser for manage.mist.com, manage.eu.mist.com, manage.gc1.mist.com, ...
  • Manage User API Token (list / delete / create)
  • Manage Org API Token (list / delete / create)

About Tab

  • Quick access to the Mist API documentation (Mist official documentation, Postman documentation, OpenAPI documentation)
  • Version check from the extension to know if a new version is available, and download new versions directly from the extension

Installation

This extension is not yet available on the Chrome Web Store or the Firefox Extension Store, but it is possible to install it in Chrome / Chromium (Edge, Brave, Sidekick, ...) and Firefox web browsers.

Chrome / Chromium

  1. Download the file mist_extension-X.Y.Z.zip from the latest release
  2. Unzip the downloaded archive
  3. Go to the web browser Extensions Page: chrome://extensions
  4. Enable the Developer Mode

  1. Click Load Unpacked and select the unzipped folder

  1. The extension is ready to use!

Firefox

  1. Download the file mist_extension-X.Y.Z.xpi from the latest release
  2. Go to about:addons url from Firefox

  1. Click on the "Settings" button, then "Install Add-on From Files..."

  1. Select the mist_extension-X.Y.Z.xpifile

Build Instruction

This extension has been build on Mac OS 12.6.1, with

  • Node 19.0.1
  • NPM 8.19.2
  • Python 3.8.5

PREREQUISITES

From the angular folder, install dependencies with npm install

RUN/DEBUG

from thge /angular/ folder:

  • build the angular app in debug mode with npm start
  • start the npx debugger with npx web-ext run -s ./dist (Firefox) or npx web-ext run -t chromium -s ./dist --browser-console (chromium)

BUILD

from the /angular/ folder:

  • build the angular app in production mode with npm run build:prod
  • build the extension with npx: npx web-ext build -s ./dist -o the extension is located in /angular/web-ext-artifacts

About

Web Browser extension for Mist Developpers to provide quick access to Mist APIs. The application is analysing the URL of the current tab to provides the org_id, site_id (if any) object_id (if any) and quick access the main API calls for this page. It can also be used to manage and generate User and Org API Token.

Topics

Resources

License

Stars

Watchers

Forks