Using the API
4
Vision
2
API Guide
Enabling IIS Security for the Administrator API
With IIS security enabled, a block of code attempting to access an API function will require an Administrator
log in. Perform the following steps to enable IIS security for the Administrative API:
1.
On the Master Server, click the following path: Start Menu > Administrative Tools > Internet Information
Services (IIS) Manager. The Internet Information Services (IIS) Manager opens.
2.
In the tree view on the left pane, navigate to
server name
> Web Sites > Default Web Site > v2Services >
V2_API.
3.
In the right pane, right-click v2_APIAdminService.asmx and select
Properties
.
4.
Select the
File Security
tab.
5.
In the Authentication and access control section, click
Edit
.
6.
In the Authentication Methods dialog box, uncheck
Enable anonymous access
, and click
OK
.
7.
Click
Apply
, then click
OK
to close the window.
Enabling Devices Which Do Not Support Windows
Authentication
For devices which do not support Windows authentication (such as a NetLinx device), calls must be made to a
proxy web service which impersonates a known user. For example, rather than calling the IIS-protected
function at the following address:
http://<server name>/v2Services/v2_API/v2_APIAdminService.asmx/v2Master_GetListOfServices?
sServiceType=v2Archive
instead, call the proxy web service at an address like the following:
http://<server name>/v2Services/v2_API/v2_AdminProxy.aspx?ReturnXML=v2Master_GetListOfServices?
sServiceType=v2Archive
When the call is made to the proxy web service, a check is performed to see whether the MAC address that
made the call is on a White List. If the MAC Address has not been enabled in the White List, an error message
returns noting that the MAC address has not been validated.
This change only needs to be made on the Master server.
All calls to the API can be proxied in this manner.
