Previous topic

Performance Concepts

Next topic

APS Types

Odin Automation SDK
Last updated 18-Oct-2017

API Reference

The reference guide 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.

Compatibility Matrix

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 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 5.5 6.0 7.0 7.1
APS API 2.0 2.1 2.2 2.3
CCP/MyCP v1 v1 v1, v2 v1, v2
APS Tools 2.0 2.1 2.2 2.2
PHP Runtime 2.0 2.1 2.2 2.3

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

  • The embedded APS controller exposes the APS API 2.2.
  • The platform allows each customer individually have either CCP v2 or CCP v1. The provider can switch the CCP version from one to another for a customer at any time.
  • When developing APS applications, the developers must use APS tools 2.2 or higher.
  • 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. In the Compatibility Matrix, use the platform version to identify the APS API version supported by the platform.

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);
    ?>
    
  2. Execute the script in the command line:

    $ php version.php
    2.3-20
    

    It prints out the APS PHP runtime version.