Für die Nutzung der CAD-ERP-Integration mittels OTA werden hier das Datenmodell, die API-Aufrufe und die möglichen Befehle zusammen gestellt.

Als Basis muß profacto-seitig die Integration eingerichtet sein, für die Anbindung von interiorcad müssen die entsprechenden REST-Befehle wie hier beschrieben aufrufbar sein.

Implementierung in einem CAD

Folgende Kommandos werden verwendet, um Artikel, Projekte, Positionen abzuholen und die Stückliste zurückzuschreiben.

Das Grundschema hierbei ist analog zur profacto API-Dokumentation: 

API-Basis = http://<Servername im LAN oder WAN |LAN oder WAN-IP|>:8080/4DAction/

API-Basis + Methode + Token = http://<Servername im LAN oder WAN |LAN oder WAN-IP|>:8080/4DAction/<api-Methode>?token=<Token>

profacto-seitig ist der Port 8080 und der URL-Pfad-Abschnitt 4DAction fest vorgegeben.

Feldtypen

Status

Speziell von profacto ausgehend kann man mit dem gegeben Token mittels eines Pings zum Server,

API-Basis/api_ping?token=<Token>

sehen, ob der Server überhaupt erreichbar ist und profacto-seitig die OTA-Integration aktiv.

Ein positives Ergebnis ist zB

{"restapi":"restintegration_active","theapi":"api_unknown","result":{"valid":true,"itemsync":true,"integration":true,"httpcode":"200","api":"Integration","personalnr":"10"}}

Ab profacto 2022.0.0 gibt es eine verbesserte und vereinfachte Steuerung:

API-Basis/api_get_integration?token=<Token>

Liefert mit dem attribut "active" per true/false zurück, ob die Integration in profacto überhaupt aktiviert ist.

API-Basis/api_put_integration?token=<Token>&active=true|false

Steuert ggf. die Integration für alle Anwender und gibt per success-Attribut zurück, ob eine Steuerung möglich war (wenn der Zugriff auf die Voreinstellung in profacto anderweitig vergeben ist, kann nicht gespeichert werden) und wie der Status nach der Ausfürhung ist. 

Artikel

Um Artikel aus profacto zu holen gelten dieselben Regeln wie mit der klassischen SQLite-basierten Schnittstelle für den Artikelstamm. 

Es werden Platten, Kanten, Beläge und Beschichtungen transferiert, keine Beschläge oder Fertigmöbel, Einbaugeräte, etc. 

API-Befehl

Parameter

Response

Projekte

Um die Projekte bzw. Aufträge aus dem ERP zu holen gibt es einen Befehl

API-Befehl

Parameter

Response

Positionen

Positionen zu eine Projekt werden entweder generell abgeholt (beim ersten Aufruf zu einem Projekt) und danach gilt es die Veränderungen nachzuvollziehen, wenn zB Positionsnummern geändert werden. 

Beispiel, welche Aktionen möglich sind, und wie diese abgefangen werden können:

API-Befehl

Parameter

Response

API-Befehl

Parameter

Beispiel-Response

{
	"deltas": [
		{
			"2020-04-29T14:23:44": {
				"PositionID": "6E7093EDD578488D8E5A7895BDC738AD",
				"CurrentPosNr": 1,
				"Description": "Infomaterial Display X\r\rHochglanz weiß gemäß Entwurfskizze von Mies van der Rohe\r6 Flyerfäche\r4 Zeitschriften",
				"OldPosNr": 1,
				"Event": "Position_changed"
			}
		},
		{
			"2020-04-29T14:23:55": {
				"PositionID": "AED06E22B90A492B8A85B59CD3CBE6FF",
				"CurrentPosNr": 14,
				"Description": "Videopräsentation und Wartebereich\r\rBank in L-Form\rProjektionsfläche mit Lautsprechern\rBeamerverkleidung an der Decke\r\r",
				"OldPosNr": 4,
				"Event": "Position_number_changed"
			}
		},
		{
			"2020-04-29T14:24:00": {
				"PositionID": "B09B61BAB7924ABCAEF19A172B84F9E7",
				"CurrentPosNr": 6,
				"Description": "Garderobe\r\rTheke in mausgrau\r\rTaschenaufbewahrung\rSchirmständer\rSchließfächer\rGarderobensystem von alfa3 integriert",
				"OldPosNr": 6,
				"Event": "Position_deleted"
			}
		}
	]
}

Falls es den Auftrag gar nicht gibt 
"error"="no_project_found"
"givenprojectno"="project" // die übergebene Projektnummer wird wieder zur Referenz zurückgegeben

"project"=false

Falls es keine Positionen gibt, die verändert wurden

"project"=true
"error"="no_posdeltas_found"

Stückliste

API-Befehl

Daten

Die Daten werden im JSON-Format übertragen. 

Beispiel JSON

Wie eine Stückliste mit diversen Teile aussehen kann, lässt sich exemplarisch an folgender Datei ansehen: