Integrating An Ap With An Xml Api Interface - Siemens SCALANCE W1750D UI Configuration Manual

Services

24.7 Integrating an AP with an XML API Interface

24.7 Integrating an AP with an XML API Interface
The XML API interface provides options to create and execute user management operations
seamlessly on behalf of the clients or users.
Integration with SCALANCE W
The XML API interface allows you to send specific XML commands to an AP from an
external server. These XML commands can be used to customize AP client entries. You can
use the XML API interface to add, delete, authenticate, query, or blacklist a user or a client.
Note
The user authentication is supported only for users authenticated by captive portal
authentication and not for the dot1x-authentication users.
Note
The user add operation performed by the XML API interface is only used to modify the role
of an existing user and not to create a new user.
You can now use HTTP or HTTPS to post commands to AP. The communication process
using the XML API Interface is as follows:
● An API command is issued in XML format from the server to the VC.
● The VC processes the XML request and identifies where the client is and sends the
command to the correct slave AP.
● Once the operation is completed, VC sends the XML response to the XML server.
● Users can use the response and take appropriate action to suit their requirements. The
response from the VC is returned using the predefined formats.
Configuring an AP for XML API integration
You can configure an AP for XML API integration by using the SCALANCE W UI or the CLI.
AP supports the configuration of up to 8 XML API server entries.
In the SCALANCE W UI
Enabling XML API server entries:
1. Click More > Services.
2. Click Network Integration. The XML API Server configuration parameters are displayed.
3. Enter a name for the XML API Server in the Name text box.
4. Enter the subnet of the XML API Server in the Subnet text box.
5. Enter the subnet mask of the XML API Server in the Mask text box.
6. Enter a passcode in the Passphrase text box, to enable authorized access to the XML
API Server.
7. Re-enter the passcode in the Retype box.
406
Configuration Manual, 02/2018, C79000-G8976-C451-02
SCALANCE W1750D UI