Dokumentation

<< Klicken Sie hier, um das Inhaltsverzeichnis anzuzeigen >>

Navigation:  »Keine Themen oberhalb dieser Stufe«

Dokumentation

Dokumentation

Sie können nach dem Erstellen einer Instanz die REST API Dokumentation direkt aus dem Server Manager starten. Dazu steht Ihnen die Funktion Dokumentation Entwicklerhandbuch_16x16 zur Verfügung.

1.Wählen Sie die gewünschte Instanz aus.

2.Klicken Sie Start > Instanz > Dokumentation Entwicklerhandbuch_16x16.

SrvMan_Dokumentation

Hinweise:

▪Um zu prüfen, ob die Proffix REST API von einem bestimmten Client aus erreichbar ist, aktivieren Sie die Dokumentation für diese Instanz. Danach können Sie die URL von diesem Client aus aufrufen und die Antwort prüfen. Die URL entspricht der URL der Instanz mit dem Pfad /api-docs, z.B. https://localhost:5002/api-docs.

▪Falls die Proffix REST API nur innerhalb eines Netzwerks, aber von aussen nicht erreichbar ist, müssen Sie sich mit Ihrem Testgerät in dieses Netzwerk verbinden. Falls Sie mobile Apps auch ausserhalb des Netzwerks nutzen wollen, müssen Sie eine eventuell vorhandene Hardware-Firewall entsprechend konfigurieren. Dort muss die definierte Port-Nummer auf den Server weitergeleitet werden.

Tipps:

▪Unter Umständen müssen Sie im Browser das Zertifikat der Instanz erlauben, bevor Sie eine Rückmeldung bekommen.

▪Die Dokumentation sollte im Normalbetrieb abgeschaltet sein, da sie nur für eine Entwicklungsphase benötigt wird.

▪Diese Funktion ist nur aktiv, wenn die Option REST API Doku aktivieren für diese Instanz nicht markiert ist.