This Knowledge Base article guides Rendition Server users through the process of configuring the Rendition Server's REST interface to enable effective communication with client applications. By setting up the REST interface, users can seamlessly integrate Rendition Server with their client applications, facilitating streamlined data exchange.
Prerequisites:
- Rendition Server is successfully installed and operational.
- Basic familiarity with editing configuration files.
Steps to Configure Rendition Server's REST Interface:
1. Locate the Configuration File:
- Navigate to the installation path of Rendition Server.
- Identify the configuration file named <ManagingNodeConfig.user.xml>.
2. Enable the REST Interface:
- In <ManagingNodeConfig.user.xml>, locate the <network> node.
- Inside the <network> node, there is a commented-out network node that needs activation for the REST interface.
3. Configure REST Settings:
- Inside the <network> node, add the following configuration snippet:
<network>
<bindings>
<conversion enableMtom="False" />
<administration />
<monitoring />
<rest port="14714" logLevel="Warning">
<fileStorage basePath="\\YourNetworkShare" />
</rest>
</bindings>
</network>
Note: Replace `\\YourNetworkShare` with the actual shared network path that Rendition Server needs to communicate with client applications via REST.
4. Verify Access Permissions:
- Ensure that the Rendition Server service account has full access permissions to the specified folder on the network share.
5. Restart Rendition Server:
- After making changes to the <ManagingNodeConfig.user.xml> file, restart the Rendition Server service to apply the new configuration settings.
6. Test the REST Interface:
- Access the Swagger interface for testing by navigating to http://localhost:14714/rs/api/rest/swagger/index.html on your web browser.
- Ensure that the Swagger interface is functional and responsive.
7. Firewall Configuration:
- Open firewall port 14714/tcp on the Rendition Server system to allow incoming REST requests.
8. Test Client Communication:
- Attempt to test the connection from the client application to Rendition Server.
- Verify that the communication is established successfully and data exchange is seamless.
By carefully configuring Rendition Server's REST interface, users can enable effective communication between Rendition Server and client applications. Following the steps outlined in this article ensures a smooth integration process and allows for optimized data exchange.
