Web API Source

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 to customize your business applications.

To add a Web API Source

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: If the Web API source requires certificate authentication. Provide the certificate store location and the thumbprint. For more information on certificate-based authentication, see Web API Certificate-based Authentication.

     Note: The thumbprint should not contain any spaces. In some machines, the characters in thumbprint should be in upper case.

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

Note: Once the Web API Source gets consumed by Web API, you can change the authentication mode and other values and save it. But when you again select the Web API Source from the drop-down, then the values from the Web API Source are populated, and the previously saved values are lost.

To sync the OpenAPI details

You can sync the OpenAPI details in the XML file located in the Resource folder in the installation path and save it in the database. Any modifications made in the XML file will be reflected in the Web API Source page when you sync.

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

   The Web API Source page appears.

10. Click Sync. 

    The OpenAPI details in the XML file located in the Resource folder in the installation path is synced and will get displayed in the Web API Source page.