359

Product support

Get help in the plugin support forum.

Categories

Note: This plugin is experimental and currently in beta status. "Beta" simply means that it is still in a development phase, it is only public for reasons of testing. This plugin will be updated as my work on Briddle.Controlpanel requires.

This plugin allows an API-client (coded by you in any programming language) to remotely perform certain management operations on your website. Now you can manage all your October websites from a single dashboard! No more logging in to client websites to see what is going on or to perform updates and install new plugins.

Features

You have to code the API-client to interact with this plugin yourself! If you want to use a ready-made solution I have also released Briddle.Controlpanel, an API-client. Alternatively, you can install 1Pilot 's FREE Remote Manager and use their SaaS solution on 1Pilot.io, to manage all your October websites in one place. Their solution offers a lot more functionality but requires a commercial subscription ($2/site/month).

As of this writing the following operations are supported:

STATUS FEATURE
YES VIEW OCTOBER VERSION
YES LIST ACTIVE PLUGINS
YES LIST LAST 10 EVENTS IN LOG
YES EMPTY LOG
YES UPDATE OCTOBER AND ANY ACTIVE PLUGINS
YES INSTALL, DISABLE OR ENABLE ANY PLUGIN
YES PERMISSIONS

Support

Please use the Support Forum (on the left side of the page for any theme or plugin) or send me a message. I also offer design and development services. You can visit my website for more information. Do not use reviews to ask for support.

Like this plugin?

If you like this plugin, you can help me to develop it further, provide support for it or make new plugins by making a donation with PayPal (left side of the page) or giving this plugin a good review :).

My other plugins include:

Hello, I am Wiego Bergsma. Please start by reading the whole documentation! If you have any questions, find a bug or experience difficulties getting the plugin to work please use the Support Forum. Only leave a Review if you are happy with the plugin or are still unhappy with the plugin after reaching out to me in the Support Forum. Thank you! Wiego

This plugin functions as a limited API-server for your website using artisan commands. It allows an API-client (coded by you in any programming language) to remotely perform certain management operations on your website (all operations are limited to update and cleanup tasks). This API does not have access to content and cannot add, modify or delete content.

Installation

To install from the Marketplace, click on the "Add to Project" button and then select the project you wish to add it to before updating the project in the backend of your website to pull in the plugin.

To install from the backend, go to Settings -> Updates & Plugins -> Install Plugins and then search for Briddle.Manager.

Getting started

Note: This plugin is experimental and currently in beta status. "Beta" simply means that it is still in a development phase, it is only public for reasons of testing. This plugin will be updated as my work on Briddle.Controlpanel requires.

  1. Install Briddle.Manager
  2. Go to Settings > Remote Manager > Remote Manager and enter the API-token required to allow remote systems to access the API (this token should always be sent in a X-Auth-Token header).

API security

  • This API is secured by an API-token that is set in the X-Auth-Token header (make it long).
  • Every site that uses this plugin uses it's own API-token.
  • The API-token itself is protected by requiring a HTTPS connection. Do NOT make API-requests over HTTP. Your request will return a 403 status but you will have compromised the API-token for that website!.
  • This API can not delete anything but it can disable your plugins.

API-endpoints

HTTPS is required when connecting to this API

The following REST API-endpoints are currently supported:

API-ENDPOINT METHOD DESCRIPTION
api/v1/core GET Returns the core version in JSON format
api/v1/update POST Updates the core and any active plugins
api/v1/plugins GET Returns the active plugins in JSON format
api/v1/install/{author/{plugin} POST or PUT Install a new plugin
api/v1/disable/{author/{plugin} POST Disables a plugin
api/v1/enable/{author/{plugin} POST Enables a plugin
api/v1/events GET Returns the event-log in JSON format (limited to 10)
api/v1/events POST or DELETE Clears the event-log

API results

API-request will return either JSON, a 401 status (invalid or missing token) or a 403 status (you are not using HTTPS)

Building your own API-client

Note: I have also released Briddle.Controlpanel, an API-client for this plugin

You can use any programming language when building your own API-client (e.g. for a dashboard to manage multiple websites). The simplified example below is written in plain vanilla javascript.

var request = new XMLHttpRequest();
request.open('GET', 'https://yoursite.com/api/v1/core', true);
request.setRequestHeader("Content-Type", "application/json");
request.setRequestHeader("X-Auth-Token", "yourtoken");
request.onload = function()
{
    if (request.status >= 200 && request.status < 400) {
        var data = request.responseText;
    } else {
        var data = 'API-server error: ' + request.statusText;
    }
    try {var data = JSON.parse(data);} catch(e){}
    console.log(data);
};
request.onerror = function()
{
    console.log('API-client error: There was a connection error of some sort');
};
request.send();

Support

Please use the Support Forum (on the left side of the page for any theme or plugin) or send me a message. I also offer design and development services. You can visit my website for more information. Do not use reviews to ask for support.

1.0.7

Make use of Illuminate\Console\Command

Sep 04, 2019

1.0.6

Enforce HTTPS

Sep 04, 2019

1.0.5

Update to authentication

Sep 04, 2019

1.0.4

Removed option to remove or refresh plugins, it is not needed

Sep 04, 2019

1.0.3

Security fix for added API-endpoints

Sep 04, 2019

1.0.2

Added API-endpoints

Sep 02, 2019

1.0.1

First version

Aug 31, 2019