OpenAPI endpoint
To properly document an API, a number of standards are available. The OpenAPI standard is the best known standard, which is why is has been selected to document the REST API.
The OpenAPI document can be used in tools such as
Postman or in
Swagger, and is intended for developers to get a better understanding of how the Planon Generic REST API works.
Example
http://{environment}/sdk/system/{version}/openapi/{definition name}.json
Calling this endpoint will return a JSON file for the definition mentioned in the endpoint.
Response
{
"openapi": "3.0.1",
"info": {
"title": "Documentation for use of the Planon Generic REST API Department definition",
"description": "This document describes how to use the Planon Generic REST API Department definition. To use this interface you have to create an api key in the Planon application.",
"contact": {
"name": "Market leading Real Estate and Facility Management software",
"url": "https://planonsoftware.com",
"email": "info@planonsoftware.com"
},
"license": {
"name": "License with product code E00910 is needed to use the Planon Generic REST API"
},
"version": "2.0.0"
},
"servers": [
{
"url": "https://planon-acc.plnd.cloud/sdk/system/rest/v2"
}
],
"security": [
{
"planon_apikey": []
}
],
"paths": {
"/read/Department": {
"post": {
"description": "Read data",
"requestBody": {
"content": {
"application/json": {
"schema": {
"properties": {
"filter": {
"$ref": "#/components/schemas/filter"
}
}
}
}
},
"required": true
},
"responses": {
"422": {
"description": "Returned upon a business error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/businessMessages"
}
}
}
},
"4XX": {
"description": "Returned upon a client error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/systemError"
}
}
}
},
[...]
},
"securitySchemes": {
"planon_apikey": {
"type": "apiKey",
"description": "Use for value: 'PLANONKEY accesskey={{SEC-TOKEN}}'",
"name": "Authorization",
"in": "header"
}
}
}
}