Integrations

API

The API parameters and settings can be accessed through the corresponding menu item API in the Integrations section.

In the Basic Auth Headers area, enter the username and password of the user who should have access to the API. If no ID is specified in the URL parameters, all records of the endpoint will be addressed.

By using the Run button, the system will display the configured query as a preview.

Preview


GET /api.php?v=1&ep=accounts

Host: example.host

Authorization: Basic aBcDeF0gHiJk1LmNoP2

Client: 00000

If the header also includes the Language parameter and a country code according to ISO-3166 as a value, the output will be in the corresponding language. Language: EN

Through the Object Manager, you can specifically enable or disable objects (endpoints) or individual fields for API access.

Advanced Queries

For the GET method, the query can be filtered not only by ID but also by any other available field. To do this, append the desired field with its corresponding value as a GET parameter to the URL.


/api.php?v=1&ep=quote_lines&quote_id=10


{

    "100": {

     "quote_id": "10",

     "number": "1",

     "position": "Example Window",

     "quantity": "2.00",


...

Advanced Services

In addition to object queries via the API, various services can also be accessed. Services offer the ability to create and retrieve (dynamic) data. The record key is required as the id.

svcConfigurationQuoteDescription
Provides the name, description, and vector graphic of configured quote items.


/api.php?v=1&ep=svcConfigurationQuoteDescription&id=100

svcConfigurationWorkOrderDescription
Provides the name, description, and vector graphic of configured work order items.


/api.php?v=1&ep=svcConfigurationWorkOrderDescription&id=100

svcShopCache
Returns information from the following endpoints in a single query: company_informations, web_preferences, images, web_navigation, web_navigation_items, web_pages, windows, doors, shadings, window_sills, garage_door, insect_protection, articles, payment_methods.


/api.php?v=1&ep=svcShopCache

svcReferencePrices
Determines the reference price for the respective standard configuration of all systems for a type. Requires the parameter typewith one of the following values: window, door, shading, window_sill, garage_door, insect_protection.


/api.php?v=1&ep=svcReferencePrices&type=window

svcDoorInfills
Returns up to 32 infills with corresponding infill properties for a door system. Requires the parameter id with the ID of the door system.


/api.php?v=1&ep=svcDoorInfills&type=door&id=1

svcShadingSurfaces
Returns up to 32 surface colors for a shading system. Requires the parameter id with the ID of the shading system.


/api.php?v=1&ep=svcShadingSurfaces&type=shading&id=1

svcWindowSillColours
Returns up to 32 surface colors for a window sill. Requires the parameter id with the ID of the window sill.


/api.php?v=1&ep=svcWindowSillColours&type=window_sill&id=1

svcInsectProtectionColours
Returns up to 32 surface colors for an insect protection system. Requires the parameter id with the ID of the insect protection system.


/api.php?v=1&ep=svcInsectProtectionColours&type=insect_protection&id=1

svcProductTypes
Returns up to 16 product types for a window system. Requires the parameter id with the ID of the window system.


/api.php?v=1&ep=svcProductTypes&type=window&id=1