Web API Source List

Web API source is used to define the details of the OpenAPI which can be then fetched through the Source dropdown of Web API List page. Use Web API Source list to customize your business applications.

To add a Web API Source List

1. In the Enterprise Console, click the Menu button, click Settings, and then click Web API Source.

   The Web API Source page appears.

2. Click New. 

   The Web API Source List Item wizard appears.

3. In the Name box, type a name for the Web API source.

4. In the Description box, type a description for the Web API source.

5. In the Swagger Url box, type the swagger url of the Web API that was created and configured using swagger.

6. In the Base Address box, type a URL in the format: http://localhost/MySite/.

   You can also enter an IPv6 URL for the Base Address. The IPv6 address must be enclosed within square brackets.

7. Select one of the following options for Authentication Mode:

   • No Authentication: If the Web API source does not require authentication.

   • Windows: If the Web API source is Windows authenticated. Provide the impersonation user.

   • Access Token: If the Web API source requires ArchestrA Security Token Service (ASTS) access token authentication.

   • Basic Authentication: If the Web API source requires basic authentication. Provide the user name with domain and the password.

   • Certificate: Not applicable.

8. Click Save. The Web API source is added.

Note:
- If the Web API source is Windows authenticated, then the status of the Windows Authentication must be set to Enabled for the EnterpriseConsole site under AVEVAWorkTasksSites site in the IIS Manager. Also the Web API source must always be hosted in the AVEVA Work Tasks web server machine.
- Certificate based Web API source is not supported.