HTTP API - NAT: Difference between revisions

From Ultiroam User Docs
Jump to navigation Jump to search
(Created page with "==== 9.1         Application Scenarios ==== DRP server can be used to communicate with the gateway behind NAT. ==== 9.2         Configuration section ==== (1)     Enable "Tools -> Remote Connection Configuration" in the gateway. (2)     Add gateway in DRP server. ==== 9.3         API Changes ==== Based on the IP and port (in the configuration file) that the DRP server is configured, the API client sends the request to that address; (1)  Connect to t...")
 
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
==== 9.1         Application Scenarios ====
'''Application Scenarios:'''
 
DRP server can be used to communicate with the gateway behind NAT.  
DRP server can be used to communicate with the gateway behind NAT.  


==== 9.2         Configuration section ====
'''Configuration section:'''
(1)     Enable "Tools -> Remote Connection Configuration" in the gateway.
 
# Enable "Tools -> Remote Connection Configuration" in the gateway.
# Add gateway in DRP server.


(2)     Add gateway in DRP server.
'''API Changes:'''


==== 9.3         API Changes ====
Based on the IP and port (in the configuration file) that the DRP server is configured, the API client sends the request to that address;
Based on the IP and port (in the configuration file) that the DRP server is configured, the API client sends the request to that address;


(1)  Connect to the DRP server and send the password of the account for authentication Request: <nowiki>https://drpserver_ip:port/doLogin?Username=admin&password=admin</nowiki>
# Connect to the DRP server and send the password of the account for authentication '''Request:''' <nowiki>https://drpserver_ip:port/doLogin?Username=admin&password=admin</nowiki> After the DRP server authentication passes, it returns 200 OK, indicating that the server accepts the subsequent requests from the API client;
 
# After passing the authentication, send the device serial number to the DRP server: '''Request''': <nowiki>https://drpserver_ip:port/remoteWeb?Product_sns=</nowiki> 0123-4567-890A-BCDE After the DRP server matches the corresponding device, it replies 200 OK, indicating that subsequent requests of the API client are forwarded to the device specified by the serial number;
After the DRP server authentication passes, it returns 200 OK, indicating that the server accepts the subsequent requests from the API client;
# Follow-up according to the specific function to send the corresponding request, see the API specific usage (the model api client requests are sent to the DRP server);
 
(2)  After passing the authentication, send the device serial number to the DRP server:
 
Request: <nowiki>https://drpserver_ip:port/remoteWeb?Product_sns=</nowiki> 0123-4567-890A-BCDE
 
After the DRP server matches the corresponding device, it replies 200 OK, indicating that subsequent requests of the API client are forwarded to the device specified by the serial number;
 
(3)  Follow-up according to the specific function to send the corresponding request, see the API specific usage (the model api client requests are sent to the DRP server);

Latest revision as of 07:50, 8 May 2024

Application Scenarios:

DRP server can be used to communicate with the gateway behind NAT.

Configuration section:

  1. Enable "Tools -> Remote Connection Configuration" in the gateway.
  2. Add gateway in DRP server.

API Changes:

Based on the IP and port (in the configuration file) that the DRP server is configured, the API client sends the request to that address;

  1. Connect to the DRP server and send the password of the account for authentication Request: https://drpserver_ip:port/doLogin?Username=admin&password=admin After the DRP server authentication passes, it returns 200 OK, indicating that the server accepts the subsequent requests from the API client;
  2. After passing the authentication, send the device serial number to the DRP server: Request: https://drpserver_ip:port/remoteWeb?Product_sns= 0123-4567-890A-BCDE After the DRP server matches the corresponding device, it replies 200 OK, indicating that subsequent requests of the API client are forwarded to the device specified by the serial number;
  3. Follow-up according to the specific function to send the corresponding request, see the API specific usage (the model api client requests are sent to the DRP server);