Portal API

The portal.robotsindeklas.nl provides a public API that can be used to automate certain tasks, e.g. creating new users and sharing standardized apps with them.

1. Introduction

1.1 Preparation

Before hands-on coding your application, you need to:

• Set up your development environment
• Have an account on portal.robotsindeklas.nl

2. REST API

2.1 The endpoint

The base URL for our REST API calls looks like this:

https://portal.robotsindeklas.nl/API/v1

2.2 Request methods

Please note that you should use the POST method for your request unless indicated otherwise.

2.3 Parameters

To send the required parameters for your request, please put them in the body of the request in JSON format.

2.4 Requesting token

To access the public API, we first have to authorize ourselves by getting a valid token to perform the desired actions. A token can be requested by making a POST request to:

https://portal.robotsindeklas.nl/API/v1/auth/getToken

In the body of the request, enter the following details:

{
    "username": "USERNAME",
    "password": "PASSWORD",
    "domain": "DOMAIN"
}

Example:

{
    "username": "Pietje",
    "password": "Password123!",
    "domain": "API School"
}

If a valid combination of username, password, and the domain is given, a bearer token is returned which can be used to authorize the public API requests.

2.5 Items

The logic of the API is divided into a number of items. Each item described a group on which we can perform certain actions. For example, with the item App we can create new apps in portal.robotsindeklas.nl or copy and/or share existing apps with your users.

• App
• Folder
• Group
• User
• Robot

2.6 Response status code

The API can return a few different status codes depending on if the call was successful or not. In general, a status of 200 means that the call succeeded and anything else that it failed. A few hints on where to begin troubleshooting can be found in the table below.

Examples

...