Windows - Enable IAA via the graphical user interface

If you did not install the Intrexx Administration API during the Intrexx installation, you can enable it later. Activation is performed using a script file named maintain.vbs. It is located in the Intrexx installation directory.

Step-by-Step

To enable the Intrexx Administration API, follow these steps:

  1. Run the Windows Command Prompt as an administrator.

  2. Run the file <Intrexx installation directory>\maintain.vbs.

    C:\<Intrexx installation directory>\maintain.vbs

    The "Installation" step of the Intrexx Setup dialog box appears.

  3. Click "Packages to Install."

  4. The "Component Selection" dialog box appears.

  5. Select the "Intrexx Administration API" checkbox.

  6. Click "Finish."

    You will return to the dialog box summarizing the installation process.

  7. Click "Advanced Settings."

    Go to the "Administration API Configuration" tab.

    Port

    Enter the port here that the Intrexx Administration API can be accessed on. Port 4242 is used by default.

    Username, Password, Confirm Password

    Enter the username and password you use to log in to the IAA here.

    After you authenticate with the IAA, you will receive the API authentication token. You need this to be able to use the IAA resources.

    For detailed information on authentication and using the API key, see the following sections:

    Use a self-signed certificate

    Select this option if you want communication between the API client (API consumer) and the Intrexx Administration API to be encrypted using a self-signed certificate (for test or development portals).
    In this case, Intrexx automatically generates a self-signed certificate and uses it for the encrypted connection.

    Use a CA-signed certificate

    Certificate Store

    Enter the path to the certificate store here.

    Certificate Store Password

    Enter the password for the certificate store here.

    More Information

    For information on generating a certificate for the Intrexx Administration API, see the " Regenerate Certificate" section.

    For detailed information about certificates in Intrexx, see the section " Certificates and Encrypted Connections in Intrexx."

  8. Click "Finish."

  9. Click "Start" and follow the installation wizard.

Manually Enter the Portal Password

After you have enabled the Intrexx Administration API, you must specify the password for your portal in the admin-api.yaml file. You can find these at the following path: \<intrexx-installation-directory>\admin-api\cfg\

For detailed information on this topic, see the section " Portal Password."