Skip to content

GitLab

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
P Portal-api
  • Project overview
    • Project overview
    • Details
    • Activity
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Members
    • Members
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • doc
  • Portal-api
  • Wiki
  • Home

Home · Changes

Page history
Update home authored Apr 08, 2022 by Jurjen Brouwer's avatar Jurjen Brouwer
Show whitespace changes
Inline Side-by-side
Showing with 52 additions and 1 deletion
+52 -1
  • home.md home.md +52 -1
  • No files found.
home.md
View page @ 0aaab1d4
Initial text
\ No newline at end of file
# Portal API
The [portal.robotsindeklas.nl](https://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](https://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 Requesting token
### 2.3 Parameters
### 2.4 Request methods
### 2.5 Items
- 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.
| Status Code | Description |
| ------ | ------ |
| 200 Ok | The request was accepted and successfully handled |
| 400 Bad Request | The request sent is incorrect. Please make sure the parameters and their values are correct. |
| 401 Unauthorized | Current Bearer token is no longer valid. |
| 403 Forbidden | You are not allowed to perform this action. Most likely due to not having enough rights to perform this action. |
| 404 Not Found | The URL to the API is not correct, or cannot be found. |
| 429 Too Many Requests | The maximum amount of allowable calls has been reached for this API request. The current API rate limiter uses a window of an hour to check if the amount of requests exceeds a pre-defined number |
| 500 Unexpected Error | An unexpected error has occurred. |
### Examples
...
\ No newline at end of file
Clone repository
  • App API
  • Folder API
  • Group API
  • Robot API
  • User API
  • Home