Fern-API über HTTP
Sie möchten vielleicht Operatoren von Ihrer eigenen Website aus erstellen und NxCloud DB automatisch aktualisieren. Sie können Ihr eigenes API-Set erstellen, um
Sie können Ihr eigenes API-Set für den Fernzugriff auf Ihre Operatoren erstellen, indem Sie die DAO- und Datenklassen von NxCloud verwenden.
Für weitere Informationen über DAO und Data-Klassen, lesen Sie DAO- und Daten-Klassen
Beispiel API Satz
Wir haben eine Beispiel-API in /nxfilter/webapps/example/remoteapi.jsp eingestellt. Sie können diese JSP-Seite aus der Ferne über das HTTP-Protokoll aufrufen.
In der JSP-Seite sind diese Aktionen definiert,
- createOperator
Mit dieser Aktion können Sie einen Operator erstellen. Sie benötigt 2 Parameter.
Einer ist 'opName' für einen Operator-Namen. Der andere ist 'opType' für den Typ des Operators, den Sie erstellen möchten,
Setzen Sie 1 für einen geschäftlichen Betreiber und setzen Sie 2 für einen privaten Betreiber. Bei Erfolg wird '/OK' zurückgegeben, bei einem Fehler '/ERR'.
ex) http://localhost/example/remoteapi.jsp?action=createOperator&opName=testname&opType=1
- selectOperator
Mit dieser Aktion können Sie die Informationen zu einem Betreiber abrufen. Sie nimmt den Parameter 'opName' für einen Operator-Namen.
Bei Erfolg wird ein JSON-Array zurückgegeben, das die Informationen des Betreibers enthält.
Im Fehlerfall wird '/ERR' zurückgegeben.
ex) http://localhost/example/remoteapi.jsp?action=selectOperator&opName=testname
- setExpDate
Hiermit wird ein Ablaufdatum für einen Betreiber festgelegt. Sie benötigt 2 Parameter.
Der eine ist 'opName' für einen Betreibernamen. Der andere ist 'expDate', eine Zeichenkette im Format 'yyyyMMdd' für das Verfallsdatum
Datum, das Sie für den Filterdienst festlegen möchten. Bei Erfolg wird '/OK' zurückgegeben, bei einem Fehler '/ERR'.
ex) http://localhost/example/remoteapi.jsp?action=setExpDate&opName=testname&expDate=20191231
Standardmäßig akzeptiert die JSP-Beispielseite nur die Aufrufe von 127.0.0.1 oder localhost. Sie müssen den Einschränkungsteil der JPS-Seite ändern, um die Anfragen von anderen Hosts zu akzeptieren.
// Only localhost access allowed.
if(!request.getRemoteAddr().startsWith("127.0.0.1")){
out.println(request.getRemoteAddr());
return;
}
Um diese Remote-API-Funktionen zu erstellen, haben wir nur die NxFilter DAO- und Datenklassen verwendet. Es ist also möglich, noch kompliziertere Funktionen zu erstellen.
Sie können eine IP-basierte ACL für Ihre JSP-Seiten haben, indem Sie System > Allowed IP > Allowed IP To GUI.