Install API Portal

This section describes the steps required to install API Portal as a software installation.

Configure MySQL for API Portal

Connect to your MySQL or MariaDB database, and configure the database for API Portal in the /etc/my.cnf configuration file as follows:

  1. To restrict the database to listen only on localhost, bind the database to localhost. Under the [mysqld] line, add the following:
  2. bind-address = 127.0.0.1
  3. Set the value for expire_logs_days. The default is 0, no automatic removal.
  4. Set the maximum size of the binary log file in max_binlog_size.
  5. Set the maximum number of connections in max_connections. The default is 151.
  6. Set sql_mode to NO_ENGINE_SUBSTITUTION,STRICT_TRANS_TABLES.
  7. Set the size of the buffer pool in innodb_buffer_pool_size.
  8. Set the size of the log files in a log group in innodb_log_file_size.

For more details on the variables and how they affect the performance of the database, see MySQL Server System Variables or MariaDB Server System Variables.

Configure a database user account for API Portal

For API Portal to be able to connect to the MySQL or MariaDB database, you must configure a user account for API Portal on your database. If you followed the steps in the prerequisites to secure the connection to the database, you have already done this. If you did not follow the steps, do the following:

  1. Connect to your database.
  2. To configure a user account, enter the following:
  3. CREATE USER '<user name>'@'localhost' IDENTIFIED BY '<your password>';

    GRANT ALL PRIVILEGES ON joomla.* TO '<user name>'@'localhost' IDENTIFIED BY '<your password>' WITH GRANT OPTION;

    GRANT ALL PRIVILEGES ON joomla.* TO '<user name>'@'127.0.0.1' IDENTIFIED BY '<your password>' WITH GRANT OPTION;

    FLUSH PRIVILEGES;

Install PHP extension

You must first install the php-mcrypt PHP extension to enable local encryption. Installing php-mcrypt also installs any other dependencies, such as php-xml and php-gd.

  1. Download and install the EPEL repository:
  2. sudo yum install epel-release

    sudo yum update

    sudo yum install php-mcrypt

If the direct download of the EPEL repository fails, try the following:

  1. Download the repository rpm:
  2. wget https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm

    sudo rpm -ivh epel-release-latest-7.noarch.rpm

  3. Install the extension:
  4. sudo yum update

    sudo yum install php-mcrypt

Install API Portal software

  1. Download the installation package for your OS from the Axway Support at https://support.axway.com, and upload it to your host machine.
  2. Log in to the host machine as the root user.
  3. Extract the installation package:
  4. # tar xpvzf <package>.tgz

    After extraction, you have the /package folder containing the rpms and two scripts.

  5. Run the install script:
  6. # sh apiportal_install.sh

    When prompted on installing additional dependencies, confirm their installation.

  7. Enter the database connection details. The default port is 3306, and the database user is the user you configured for API Portal.
  8. To configure the SE Linux, enter the following commands:
  9. setsebool -P httpd_read_user_content 1

    setsebool -P httpd_can_network_connect 1

    setsebool -P httpd_can_network_connect_db 1

    setsebool -P httpd_unified 1

    chcon -R -t httpd_sys_content_t /opt/axway/apiportal/htdoc/

    semanage fcontext -a -t httpd_sys_rw_content_t '/opt/axway/apiportal/htdoc(/.*)?'

    restorecon -R -v '/opt/axway/apiportal/htdoc'

  10. Log in to the Joomla! Admin Interface (JAI) (https://<API Portal host>/administrator) using the default Joomla! administrator credentials to verify the portal configuration tools work.
  11. Note   Contact your Axway Account Manager to retrieve the default administrator credentials. It is mandatory that you change these credentials when you first log in.

Install Joomla! components

You must also install the EasyBlog and EasyDiscuss components.

  1. Log in to the Joomla! Admin Interface (JAI) (https://<API Portal host>/administrator) using the default Joomla! administrator credentials.
  2. Note   Contact your Axway Account Manager to retrieve the default administrator credentials. It is mandatory that you change these credentials when you first log in.
  3. Click Components > EasyBlog, and follow the instructions in the EasyBlog installer.
  4. Select Installation via Directory, select com_easyblog_5.0.44_component_pro.zip from the Select Package drop-down list, and follow the instructions in the installer to the finish.
  5. Note   Do not install any of the modules and plugins unless you plan to use them. To prevent installing any modules, click Modules and deselect Select All, then repeat the same for Plugins.
  6. Click Components > EasyDiscuss, and repeat the component installation as described for EasyBlog. In Select Package, select com_easydiscuss_4.0.13_component_pro.zip from the drop-down list.
  7. Note   Do not install any of the modules and plugins unless you plan to use them. To prevent installing any modules, click Modules and deselect Select All, then repeat the same for Plugins.

Post-installation steps

  • Before you can log in to your API Portal (https://<API Portal host>) and verify that the installation succeeded, you must link API Portal to API Manager. For more details, see Link API Portal to API Manager.
  • In addition, there are some configuration steps you must perform to protect your API Portal configuration. For more details, see Configure API Portal.

Related Links