Specifying the API URL for Direct Links

Introduced in 8.7.3

Before using API, you must specify its URL that is stored in the database as the value of the web application link macro. This macro is used to build direct links to objects in various workflow notifications.

To customize the API link system macro:

  1. In the Settings App, go to Workflow and Business Logic > Advanced > System Macros.

  2. Enter your URL value in the API Link field.

  3. Click Save from the module menu to save your changes.

NOTE: Alternatively, you can customize the macro when configuring the API, using the Web Configuration tool. For details, see Installation Guide: Customizing the API Link Macro.

More information about the URL

The URL of the API must be in the following format:

[site name]:[port number]/[virtual directory name]

If you install your web server instance to the root directory of a web site, the URL will be a direct reference to this site. For example, http://www.company.com/.

If you are using a virtual directory for your web service configuration, the virtual directory name should be a part of the URL. For example, if your server's host name is "www.company.com", specifying "api" as the virtual directory name will result in the following URL: http://www.company.com/api/.