Installing Plugin

There are two different ways to install a custom plugin:

  • Operator Control Panel

  • API

Operator Control Panel

To install a plugin through the Operator Control Panel, you will have to upload the plugin JSON file.

First, go to the Plugins section of the Operator Control Panel and click on the My plugins tab.

Once there, you will be able to see the green button ADD THIRD PARTY PLUGIN

First, you will be asked to confirm that you will like to install a third party plugin. Then, you will be able to upload the JSON file.

If the uploaded file has the correct format, you will once again be asked to confirm the process by typing in I UNDERSTAND. Once confirmed, your plugin will be installed to your exchange.

API

To install a plugin through the API, you can use the endpoint POST <API_URL>/plugins with the plugin JSON object above passed as the request body.

post
Install Plugin

https://<API_URL>/plugins
Install a plugin
Request
Response
Request
Headers
authorization
required
string
Bearer token
Body Parameters
public_meta
optional
object
Plugin public_meta object
type
optional
string
Plugin type
enabled
required
boolean
Enable/disable the plugin on installation
name
required
string
Name of plugin
version
required
number
Plugin version
script
required
string
Plugin script
meta
optional
object
Plugin meta object
prescript
optional
object
Plugin prescript object. Valid keys: install, run
postscript
optional
object
Plugin postscript object. Valid keys: run
icon
optional
string
Plugin icon url
documentation
optional
string
Plugin markdown documentation
url
optional
string
Plugin url
bio
optional
string
Plugin simplified bio
logo
optional
string
Plugin logo url
description
optional
string
Plugin long description
author
optional
string
Plugin author
admin_view
optional
string
Plugin admin_view
web_view
optional
string
Plugin web_view
Response
200: OK
{
"name": "hello-exchange",
"version": 1,
"author": "bitHolla",
"enabled": true,
"description": "Demo plugin for proof of concept",
"bio": "Demo plugin",
"public_meta": { ... },
"web_view": null,
"updated_at": "2021-03-08T04:06:03.357Z",
"created_at": "2021-03-08T04:06:03.357Z",
"documentation": null,
"logo": null,
"icon": null,
"url": null,
"enabled_admin_view": false