Note: IIS requires ASP .NET 4.5 or higher to be installed for the web service.
A new website is added to IIS, Task API Web Site, upon installation. By default, access to the website is over port 8800 if using HTTP, or 4433 over HTTPS. If required, change the port number bindings in the IIS Manager if either of those ports are in use elsewhere on your network.
Click the image to view full size.
For a detailed description of how to use HTTPS with the API Web Service, go to our knowledge base article: Using HTTPS with the BPA Platform Web Service API.
Changes Required for Web.Config
By default, the API’s configuration file, Web.Config, is in the installation folder:
C:\Program Files (x86)\Codeless Platforms\TaskApiSvc\
Tip: You can also open the installation folder from the IIS Manager: Highlight Task API Web Site in IIS Manger, and select Explore from the Actions pane.
No changes are required to the API’s configuration file if:
| ► | The API Web Service is installed locally to the BPA Platform server running the API’s tasks |
| ► | Only the REST service is used |
| ► | Authentication is made using HTTP headers |
Note: If authentication does not use HTTP headers and the REST service is used, you must provide authentication credentials in the Web.Config file.
However, if any of the criterion below are met, you must edit the Web.Config file (the relevant parameter names are detailed underneath):
| ► | The API Web Service is installed remotely to the BPA Platform server running the API’s tasks |
| ■ | Parameter: <add key=”TcServer” value=”{hostname}” /> |
Change {hostname} to the remote server name.
| ► | SOAP actions are required |
| ■ | Parameter: <add key=”TcUsername” value=”{username}” /> |
Change {username} to the BPA Platform username created specifically for the API.
| ■ | Parameter: <add key=”TcPassword” value=”{password}” /> |
Change {password} to the BPA Platform username’s password.
| ■ | Parameter: <add key=”TcUseWindowsAuth” value=”{true/false}” /> |
If the BPA Platform username specified above uses Windows domain credentials, set value to true, else leave it as false (user uses BPA Platform Authentication).
Note: The default authentication method is using REST with HTTP headers; all authentication parameters are commented out of the Web.Config file. If changing the parameters above, ensure you un-comment this section first.
| ► | Authentication is made using another method rather than HTTP headers |
| ■ | The same parameter changes as detailed for “SOAP actions are required” must be made |
Supported Protocols and Their Usage
For details of the functions, objects, and so on included in the API, request our BPA Platform API Web Service v2.0 White Paper from your account manager or business partner.