Grundsätzliche Informationen zur API sind im Bereich API & OTA-Integration bzw. zur OTA im Speziellen unter CAD-ERP Integration zu finden. Hier wird nur die konkrete Steuerung in den Voreinstellungen selbst dokumentiert.
Hier werden alle Aspekte der API und als Teil der API auch der OTA-Integration gesteuert.
Steuerung
Die öffentliche Server-Adresse ist die IP oder besser Domain, über die der Server - sofern gewünscht - auch außerhalb des lokalen Netzwerkes erreicht werden kann. Diese Adresse muß über den Port 8080 zumindest im (W)LAN erreichbar sein. Es ist nicht dazu gedacht für VPNs genutzt zu werden.
Mit Logging - einfach / detailiert - wird bestimmt wie viele Daten das Log für die Over-the-Air Integration und API erfasst. Diese Daten sind über die SystemInfo (profacto-Symbol) und dort "Logs" erreichbar.
CAD-Integration
Mit profacto 2022.0.0 wird die Integrationswahl zwischen CAD-Integration per OTA (Over the Air) und der alten Form per Austauschdatenbank entfallen. Man kann von da an die Integration nur noch abschalten bwz anschalten, für profacto SmallBusiness und profacto StartUp ist dies nur aus dem CAD heraus möglich sofern es diese Funktion unterstützt.
Der Start des CAD kann zwischen Schildkröte und Hase verzögert werden, um in langsameren Netzwerken etwas Geduld walten zu lassen. Das hat nur beim Start von Vectorworks interiorcad einen einmaligen Einfluß, der von Schildkröte = 10 bis Hase = 2 Sekunden changiert.
Wann keine Standard aktivieren?
Tokenmanager
Die Tokens steuern den Zugriff auf profacto per API und OTA-Integration. Tokens können nach Belieben erzeugt werden, benötigen einen Mitarbeiter für die Zuordnung, jedoch keinen anderweitig geregelten profacto-Account. Rechte, die in profacto selbst gelten, werden nicht auf den API-Zugriff angewendet. Ausnahmen gibt es nur für die OTA-Integration, die separat dokumentiert ist.
Tokens für die Integration werden ab profacto 2020.3.0 automatisch erstellt, sobald die OTA-Integration aktiv ist.
Der Button Craftboxx erstellt je nach Version (profacto Small Business, profacto) ein Set an fertigen Tokens, und überträgt diesen Zugang an Craftboxx. Wichtig ist dafür vorab die Server-Adresse in den Voreinstellungen erfasst zu haben, damit auch diese übertragen werden kann. Ebenso muß man sich auf demselben Rechner bei Craftboxx schonmal angemeldet haben (im Browser).
Ein Token ist einfach ein langer alphanumerischer Schlüssel, der innerhalb von profacto absolut eindeutig ist. Mit Erzeugung eines neuen Tokens muss noch ein Personaleintrag (rechter Mausklick öffnet Auswahlliste) gewählt werden und die API (rechter Mausklick öffnet Auswahlliste) für dieses Token. Es können also je Mitarbeiter diverse API-Zugriffe geben und je API können zahlreiche Mitarbeiter den Zugriff erhalten.
Sobald ein Token-Eintrag fertig ist, kann man dieses Token per E-Mail versenden werden oder das Token als Datei speichern. Alternativ kann man das Token in die Zwischenablage legen, und dann weiter verarbeiten. Bei letzterem wird nur das Token selbst mitgegeben.
In der email werden auch Beispielaufrufe und ergänzende Hinweise gegeben.
E-Mail Vorraussetzungen (ab profacto)
Für den Versand der Tokens müssen
- email-Adresse des Empfängers aus dem Personal mitkommen (empfohlen)
- oder die Adresse manuell zum Token erfasst werden
- Die email-Versand-Einstellungen auf der Seite Voreinstellungen:profacto Administration sauber konfiguriert sein - das sollte man also vorher angehen.
Die Laufzeit-Limitierung ist derzeit auf 5 Jahre festgelegt, Sie können die Tokens aber auch einfach löschen. Ein weniger lang geltendes Token kann nicht erstellt werden.
Durch das Token wird später zweierlei erkannt: welche Person ruft eine API auf, und welche API ist überhaupt erlaubt.
Die weitere Verwendung ist hier dokumentiert API & OTA-Integration