Integration

API

Die API-Parameter und Einstellungen können über den entsprechenden Menüpunkt API in der Rubrik Integrationen aufgerufen werden.

Geben Sie in dem Bereich Basic Auth Headers die Benutzerkennung und das Passwort des Benutzers an, der Zugriff auf die API erhalten soll.
Sofern keine ID bei den URL Parametern eingetragen ist, werden alle Datensätze des Endpunktes angesprochen.

Mittels des Buttons Ausführen gibt das System die eingestellte Abfrage als Vorschau aus.

Vorschau


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

Host: beispiel.host

Authorization: Basic aBcDeF0gHiJk1LmNoP2

Client: 00000

Wir zusätzlich im Header der Parameter Language und ein Ländercode gemäß ISO-3166 als Wert übermittelt, erfolgt die Ausgabe in der entsprechenden Sprache. Language: EN

Über den Objektmanager lassen sich gezielt Objekte (Endpunkte) oder einzelne Felder für den Zugriff via API freischalten bzw. deaktivieren.

Erweiterte Abfragen

Für die GET-Methode, kann die Abfrage neben der ID auch über jedes andere verfügbare Feld gefiltert werden. Fügen Sie hierzu das gewünschte Feld mit zugehörigem Wert als GET Parameter an die URL.


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


{

    "100": {

     "quote_id": "10",

     "number": "1",

     "position": "Beispielfenster",

     "quantity": "2.00",


...

Erweiterte Services

Neben den Objektabfragen via API kann auch auf verschiedene Services zugegriffen werden. Services bieten die Möglichkeit (dynamische) Daten zu erzeugen und abzurufen. Als id wird der Datensatzschlüssel gefordert.

svcConfigurationQuoteDescription
Liefert den Namen, die Beschreibung und die Vektorgrafik von konfigurierten Angebotspositionen.


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

svcConfigurationWorkOrderDescription
Liefert den Namen, die Beschreibung und die Vektorgrafik von konfigurierten Auftragspositionen.


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

svcShopCache
Gibt mit einer Abfrage die Informationen der folgenden Endpunkte aus: 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
Ermittelt den Referenzpreis für die jeweilige Standardkonfiguration aller Systeme für einen Typen.
Benötigt den Parameter type mit einem der folgenden Werte: window, door, shading, window_sill, garage_door, insect_protection


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

svcDoorInfills
Gibt bis zu 32 Füllungen mit entsprechenden Füllungseigenschaften für ein Haustürsystem zurück.
Benötigt den Parameter id mit der ID des Haustürsystems.


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

svcShadingSurfaces
Gibt bis zu 32 Oberflächenfarben für ein Verschattungssystem zurück.
Benötigt den Parameter id mit der ID des Verschattungssystems.


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

svcWindowSillColours
Gibt bis zu 32 Oberflächenfarben für eine Fensterbank zurück.
Benötigt den Parameter id mit der ID der Fensterbank.


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

svcInsectProtectionColours
Gibt bis zu 32 Oberflächenfarben für einen Insektenschutz zurück.
Benötigt den Parameter id mit der ID des Insektenschutzsystems.


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

svcProductTypes
Gibt bis zu 16 Produkttypen für ein Fenstersystem zurück.
Benötigt den Parameter id mit der ID des Fenstersystems.


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