Get Started

The API needs to be enabled in plugboard by activating an API-connector. The API-connector is handled like any other integration in Plugboard. The first step is to setup a system integration of the type Plugboard API. The integration is added in the admin area for "My Plugboard". The login details you get will allow access to the Plugboard API for a given tenant.

1. Login to My Plugboard (https://my.plugboard.io)
2. Go to System integrations -> Settings
3. Click on Add system integration
4. Choose Plugboard API as System
5. Enter a name e.g. "API"
6. Click on API Credentials
7. Copy value of field X-ConnectionId and X-Tenant
8. Click Save
9. A new widget will appear underneath

Parameters

X-tenant

is the tenant name. You can see it under API Credentials

X-ConnectionId

is a unique id for the API-connection. You can see it under API Credentials

username

is the username for the user that you want to use for the API calls.
It is recommended that you have a specific user for the API.

password

is the login password for the user you selected.

Read more about in the section Authentication
This value is to be used in the top bar of API-reference (together with the other three regular authentication details). See: API-reference documentation

Recommendations

Create one connection for every external system that connect to Plugboard by the API. Every connection can save a unique reference to an object (remoteId) which allow the remote system to add its own reference. The remoteId can be used as an identifier when calling the API.

An API connection SHOULD have its own Plugboard user. It is also recommended to use unique API-users for every API-connection.

Check Connection

Test the credentials by accessing the root API-endpoint https://api.plugboard.io/api/. Expected response should have HTTP Status Code: 200 and contain some meta data for the API-connection.

Connect using the API-reference page

Test with swagger on the API-reference page.

1. Click in Authorize and make sure to authorize all Available authorizations.
2. Go to API Root, click on Try it out
3. Click on Execute button.

Connect using curl

Test the endpoint with curl.

  curl -u user:pass --location --request GET 'https://api.plugboard.io/api/' \
  --header 'X-ConnectionId: {connectionId}' \
  --header 'X-Tenant: {your tenant}'