|Base virtual path|
|If this rule matches||Perform an internal redirection|
|Next action||Stop matching|
The instructions for IIS cover two possible configuration scenarios, setting up a site dedicated for your API endpoint or adding an API endpoint to an exsiting site as a virtual directory. Please follow the section which applies to your configuration. Regardless of your configuration you must make security changes in IIS to enable the execution of EXE CGI scripts:
- Ensure the CGI-exe handler mapping has been configurated to allow execution.
- Add an ISAPI and CGI Restriction to enable OECGI4.exe to execute from the location where it resides. The actual path depends upon your site configuration and will be referenced in the instructions below.
Dedicated API site Domain or Subdomain
When setting up a website dedicated to host the API endpoint (i.e. api.example.com ) follow these steps:
- Place OECGI4.exe in the website root directory so it is accessible using the path api.example.com/oecgi4.exe
- Update your ISAPI and CGI Restrictions settings to ensure OECGI4.exe is allowed to execute from the website root directory.
- Create the following URL Rewrite rules in the root directory:
Your API will be accessible by two URLs. The primary URL for your API will be www.example.com/api but you you can access www.example.com/oecgi4.exe/ to bypass the URL rewrite rules which may be useful to do as a troubleshooting step.
Adding an API to an Existing Site
- On the web server copy OECGI4.exe into a separate directory to be used as a CGI directory such as C:\revsoft\oecgiapi
- Update your ISAPI and CGI Restrictions settings to ensure OECGI4.exe is allowed to execute from the directory C:\revsoft\oecgiapi.
- In the website root directory create a virtual directory named oecgiapi pointing to c:\revsoft\oecgiapi. OECGI should be accessible using the url www.example.com/oecgiapi/oecgi4.exe
IMPORTANT: The virtual directory name should not be the same name as the virtual directory name. If your virtual directory name and API name are the same the IIS rewrite rules will require additional configuration to prevent IIS from ignoring the rewrite rules. This is outside the scope of the basic configuration guide contained below.
- Create the following URL Rewrite rules in the root site directory: