InduSuite APIs

An API (Application Programming Interface) is a set of rules and protocols that allows different software applications to communicate with each other. It defines methods and data formats that applications can use to request and exchange information.
InduSuite apps provides Web APIs (or REST APIs), answering client requests in standardized JSON format.
Any third party application capable of running REST API calls can interact with InduSuite API.

API management menu can be found in Settings app under Company settings .



API management is available only to the InduSuite account main administrator. If your user has no rights to access it, you will be notified.

APIs overview

Authorized users for API management will have access to API key and documentation

Please make sure to to share the API key only with people authorized to access your company data stored in InduSuite apps

API Endpoints

Please find below the list of currently available API Endpoints:

https://api.indusuite.com/api/devices/
https://api.indusuite.com/api/personnel/

For each endpoint you have detailed information in documentation together with required parameters for API calls

API call examples

In API management page, together with documentation, you also have the opportunity to try out API calls to your instance, without the need of third party software.
Please have a look at some examples below.

API call to get the list of all welding equipment connected in WeldCloud


API call to update the list of roles for a personnel member

In this example, we assume to have a personnel member created in InduSuite with just a Fitter role assigned.
Goal of our API call is to add Welder role to this personnel member

In this second example, we need to split the task in two steps and un two API calls.
First API call is used to get the personnel member ID and the JSON payload of the personnel member item we want to update.
Second API call will add the Welder role to the personnel member with the specified ID.

Let's have a look at the first API call.

Now that we got the personnel member ID and the JSON payload , we will run the second API call to add Welder role.
Let's have a closer look at the JSON payload.

{
      "id": "03783141-ed39-4949-9e78-0a2a4e9b6320",
      "displayName": "Sample Welder",
      "sites": [
        "Welding Department"
      ],
      "email": null,
      "firstName": "Sample",
      "secondName": "Welder",
      "operatorId": "DD8175",
      "operatorUsername": "",
      "nfcId": "",
      "language": "en-GB",
      "unitOfMeasurement": "metric",
      "stamp": "SW706",
      "isActive": true,
      "activeUntil": null,
      "roles": [
        "Fitter"
      ],
      "isDeleted": false
    }

Here is a list of all the properties you can update. Please note that you must send the complete JSON payload in the update API call. The API engine will compare the existing properties with those in the JSON payload and update values as needed. Any unchanged properties will remain unaffected by the update call.

In our example we want to add the Welder role to our personnel member.
Let's change the roles array to reflect our change.

{
      "id": "03783141-ed39-4949-9e78-0a2a4e9b6320",
      "displayName": "Sample Welder",
      "sites": [
        "Welding Department"
      ],
      "email": null,
      "firstName": "Sample",
      "secondName": "Welder",
      "operatorId": "DD8175",
      "operatorUsername": "",
      "nfcId": "",
      "language": "en-GB",
      "unitOfMeasurement": "metric",
      "stamp": "SW706",
      "isActive": true,
      "activeUntil": null,
      "roles": [
        "Fitter", "Welder"
      ],
      "isDeleted": false
    }

JSON payload we want to send through the update API call has the roles array including both the Fitter and the Welder role.
Now we will run the update API call using the JSON payload we have created.

Updated on: 05/11/2024