Windows - Activating IAA via the graphical user interface

If you did not install the Intrexx Administration API during Intrexx installation, you can activate it later. The activation is done via a script file maintain.vbs. This is located in the Intrexx installation directory.

Step-by-step guide

Proceed as follows to activate the Intrexx Administration API:

  1. Start the Windows command line as an administrator.

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

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

    The Intrexx setup dialog step "Installation" is displayed.

  3. Click on "Packages to be installed".

  4. The "Component selection" dialog box is displayed.

  5. Activate the "Intrexx Administration API" checkbox.

  6. Click on "Finish".

    You will be returned to the dialog with the overview of the installation process.

  7. Click "Advanced settings".

    Go to the "Administration API configuration" tab.

    Port

    Specify the port here at which the Intrexx Administration API can be reached. By default, port 4242 is used.

    User name, password, repeat password

    Enter the user name and password for your IAA authentication here.

    After you authenticate to the IAA, you will receive the API Authentication Token. You will need this in order to use the IAA resources.

    Detailed information on authentication and the use of the API key can be found in the following sections:

    Use self-signed certificate

    Select this option if the communication between the API client (API consumer) and the Intrexx Administration API is to be encrypted with 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 CA-signed certificate

    Certificate store

    Store the path to the certificate store here.

    Password of the certificate store

    Enter the password of the certificate store here.

    More information

    More information on generating a certificate for the Intrexx Administration API can be found in the section Regenerate certificate.

    Detailed information on certificates in Intrexx can be found in the section Certificates and encrypted connections in Intrexx.

  8. Click on "Finish".

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

Manually saving the portal password

After you have activated the Intrexx Administration API, save the password for your portal in the admin-api.yaml file. This can be found under the following path: \<intrexx-installation-directory>\admin-api\cfg\

For more detailed information, see the section Portal password.