Configuring the API module

You configure the API module using the Web Configuration tool. By default, if you left the Run the Web Configuration check box selected on the Completed page of the Setup Wizard, the manager starts after you complete the installation.

You can launch the Web Configuration tool from the Windows Start menu or using the Alloy Control Panel.

INFO: For details, see Using the Alloy Control Panel.

NOTE: After you complete the initial configuration, you can always use the Web Configuration tool to modify your configuration. For details about available settings, see Pre-Configuration Considerations.

To configure the API module:

  1. On the main menu of the Web Configuration tool, click File > Create > Alloy Navigator API. This step applies only if you cleared the Run the Web Configuration check box in the last step of the installation procedure on the Completed page of the Setup Wizard.
  2. On the Database page, specify the Database Access key that the API module will use to connect to your ANX8 database.
    1. Click Import Key and import the Database Access Key. This populates the SQL Server and Database fields with the values from the imported key.

      INFO: For details, see Importing the Database Access Key and Distributing the Database Access Key.

    2. Fine-tune the database connection details, if needed: in the SQL Server field, enter the network address of the SQL Server, which may differ from the SQL Server name specified in the Database Access Key.

    Click Next.

  3. On the Timezone page, specify the timezone of Alloy Navigator Express. The Web Configuration tool suggests the timezone of the IIS server where the API is installed. To change this setting, choose the timezone that you want from the Timezone list.
  4. INFO: For instructions, see Choosing Timezone.

    Click Next.

  5. On the Web page, type a description of your web service. This description will help you and other administrators identify this API module instance on the IIS server. Click Next.
  6. On the Installation Type page, specify where to install the API module:
    • If you want to install the API module as a web site, i.e. to the root directory of a web site, click Install as a web site.
    • If you want to install the API module to a virtual directory on a web site, click Install into a virtual directory.

      INFO: For instructions, see Choosing Installation Type (API).

    Click Next.

  7. On the Web Site page, all web sites available on the IIS server are displayed. Choose the site where you want to install the API module. If you are installing the API module as a web site, you can specify parameters for the new site. Click Next.
    • If you are installing the API module into a virtual directory, the Virtual Directory page opens. Proceed to the step describing the Virtual Directory page.
    • If you are installing the API module as a site, the User Authentication Type page opens. Proceed to the step describing the User Authentication Type page.
  8. On the Virtual Directory page, type the name of the virtual directory to create, or select an existing directory from the list.

    NOTE: The virtual directory name will become a part of the URL you will be using to access the API. For example, if your server's host name is "www.example.com," specifying "api" as the Virtual Directory Name will result in the following URL: http://www.example.com/api/.

    Click Next.

  9. On the User Authentication Type page, choose the authentication type for API users:

    • Windows Authentication — this option will enable users to send requests to the API under their current Windows accounts, without having to obtain an access token and specify it in requests.
    • Access Token Authentication — this option will require that users first obtain an API access token and then specify it in the Authorization section of every request sent to the API.

    Click Next.

  10. On the Workflow Integration page, you can specify the URL address for the API Link macro. This macro is used in workflow notifications to generate direct links to objects.

    INFO: For details, see .

    The Web Configuration tool detects the URL address automatically and suggests to use this value by default. To replace the auto-detected URL with your custom value, click Replace the macro’s value with a custom URL and type in your custom URL address.

    TIP: Applying the suggested URL is the best choice when the web service instance is to be accessed only over the local network. When the web service will be accessed over the Internet, you may need to type in the real URL manually. Keep in mind that you can skip this step, complete the configuration, and then run the Web Configuration tool again to replace the macro contents with the real URL.

    Click Next.

  11. On the Ready to Apply Settings page, review your settings. To make changes, click Previous to return to the relevant page or pages. When you have finished, click Apply. Wait for the Web Configuration tool to configure the web service.
  12. When completed, the Web Configuration tool displays a summary of applied settings.

    NOTE: After you complete the initial configuration, you can always use the Web Configuration tool to modify any settings.

Now the API module is ready for use. For more information on testing and using the API, see API User’s Guide.

NOTE: If your API module does not work as expected and you need to send the debug information to our Support Team, click Help > Debug Information on the main menu. The Web Configuration tool will generate the WebConfigDebugInfo.txt file and open it in Notepad.

NOTE: If you want to view the log file, go to the Error Logs section at the bottom of the Web Configuration tool’s page and click View Details.

INFO: For details on Technical Support, see Contact Information.