Table Of Contents

Application Packaging Standard

Last updated 16-Jul-2018

API Reference

A set of reference guides contains the full formal description of the application programming interface (API) and other components that system integrators use to integrate the platform services, 3rd party systems, and cloud applications via the APS ecosystem.

Version Mapping

In the long way of platform development, the platform itself, APS API, the control panels, and the APS tools changed their versions many times. The newer versions are backward compatible with the older ones, for example:

  • An APS application that functions in the platform version 7.2 will also function in the newer versions (7.3 and so on) of the platform without any updates in the application.
  • If an APS package was built successfully using the APS tools version 2.1, the same package will be successfully created using the newer APS tools, that are 2.2 and higher.

Note

The forward compatibility is not supported. For example, if the aps build tool version 2.2 builds successfully an APS package from a project, it does not guarantee that the aps build tool version 2.1 can do the same.

Although the APS controller and the APS JavaScript framework are internal components of the platform, the version of the APS API exposed by them differs from the platform version. The APS tools and APS PHP runtime are external components with their own versioning.

The following table maps those versions to each other to help you identify which versions of APS API, CCP, the APS tools and PHP runtime you can use on a certain version of the platform.

Platform 7.1 7.2 7.3
APS Tools 2.2 2.2 2.2
PHP Runtime 2.2 2.3 2.3

For example, from this table follows, that if the version of your platform is 7.1, it means:

  • When developing APS applications, the developers must use APS tools 2.2 to verify and build APS packages compatible with the platform. The platform also allows the deployment of APS packages built with older versions of the APS tools.
  • To install APS connectors over the APS PHP runtime, the providers must use the APS PHP runtime version 2.2 or higher.

Version Identification

Platform and APS

To identify the version of the platform and APS follow these steps.

  1. Log in to the provider control panel (PCP).
  2. Navigate to System > Information.
  3. In the Current build information section, find the Version of the platform.
  4. Identify the APS API version by sending a GET request to the APS controller with the /aps path in the URL.
  5. Get the full version of APS JavaScript framework by addressing your web browser to http://doc.apsstandard.org/<platform-version>/aps/2/ui/runtime/version.html.

Customer Control Panel

Providers can assign a CCP version individually to each customer. Follow these steps if you need to identify which CCP version is assigned to some customers and to reassign it if necessary:

  1. Log in to the provider control panel (PCP).
  2. Navigate to System > Settings.
  3. In the Control Panels section, click Enable/Disable CCP v2.
  4. On the Customers tab, you will find the list of customers. The Control Panel column allows you to identify the CCP assigned to each customer.
  5. To assign the needed CCP version, select the customers you wish to update and then click either Enable CCP v1 or Enable CCP v2 depending on the version you wish to assign.

APS Tools

If you have the APS command line tools installed on your computer, run the following command to identify the tools version:

$ aps help

PHP Runtime

On an endpoint Linux host, identify the installed APS PHP runtime version using the standard RPM request:

# rpm -q aps-php-runtime

On the other OS, do it in two steps:

  1. Prepare a PHP file, for example, version.php:

    <?php
    require_once 'aps/2/rest.php';
    print_r(Rest\RestService::VERSION."\n");
    ?>
    
  2. Execute the script in the command line:

    $ php version.php
    2.3-55
    

    It prints out the APS PHP runtime version.