Troubleshooting

4

• User hasn’t received onboarding email
• The share link is blank
• I can’t access my account
• Unable to build a new diagram or create a new project

How-to Guides

28

• Build your first project
• Build your first bowtie diagram
• Add new elements
• Add and edit metadata
• Assess risk using the risk assessment matrix
• Customise the view
• Download an image
• Share a diagram
• Excel import/backup
• Add a new user

Salus Suite API Documentation

Contents

• Base URL

• Authentication

• Obtaining your API Key

• Errors

• Rate Limits 

Base URL

Welcome to the Salus Suite API! This guide is designed to provide you with all the information needed to integrate with our API, allowing you to build and manage your bowtie diagrams effectively. Whether you’re looking to connect bowtie diagrams with Power BI, retrieve information about your diagrams or users, or upgrade your diagrams, this documentation will help you get started quickly. 

All API requests should be made to: 

https://publicapi.salus-suite.com/api

Swagger documentation

Authentication

To make API requests, you’ll need to authenticate using an API key. Include your API key in a HTTP header with each request like so: 

X-API-KEY: YOUR_API_KEY 

Obtaining your API Key at a glance

 Step 1: Log into your Salus Suite account.  

Step 2: Navigate to the ‘Settings’ tab in your Dashboard by clicking the three horizontal dashes in the top left-hand corner.

Step 3: Upon pressing this button, a new side menu will be shown below. In the menu select ‘Settings’ this will take you straight into the ‘Company Info’ tab. You can navigate through all the main setting types via the top slider. Further along the slider bar In the top tool bar there is  ‘Developers’ tab, click this to access the API security key within the new tab. 

Notes:

Below the API Key there are two buttons ‘Disable API Key’ and ‘Reset API Key’. 

Clicking the ‘disable API Key’ will permanently delete the API key. This means any applications currently using this API key will be logged out.

Clicking the ‘Reset API Key’ will permanently replace the previous API Key. This means any applications using the previous API key will be logged out. 

Errors

Our API uses conventional HTTP Response Codes to indicate the success or failure of an API request.

Here are the types of responses you might receive: 

• 200 OK - The request was successful. 

• 400 Bad Request - There was an issue with the request (missing parameters or invalid data). 

• 401 Unauthorized - Your API key was missing or incorrect. 

• 404 Not Found - The requested resource does not exist. 

• 500 Internal Server Error - We had a problem with our server. Try again later.

Rate Limits

To ensure the quality of our services, we implement rate limiting. If you exceed the number of allowed requests, you will receive a 429 Too Many Requests response. Please contact support if you consistently hit these limits. The API is rate-limited to 10 requests a second.