Previous topic


Next topic


Last updated 12-Jul-2017

Getting Started

To start integrating your application with APS-enabled systems, the getting started process includes required and optional steps as follows.

  • Get familiar with APS fundamentals
  • Get ready an APS-enabled hosting system for testing
  • Get ready your local APS development environment
  • Study a sample process of integrating a demo application
  • Start your own project

Get familiar with APS Fundamentals

Self-paced APS introductory video documents will help you get introduced to APS principles.

Download PPT slides.

Get ready APS-enabled Hosting System

The ultimate goal of an APS package is to provision application services to customers through an APS-enabled hosting system. We recommend you to consider the following options when choosing a system:

  • Use your own lab or test system. Clarify with the system administrators if the system is APS-enabled.
  • Use your production hosting system, when you are going to deploy certified APS packages for provisioning application services to customers of this system.
  • Order APS Sandbox with relevant configuration for testing your packages. The sandbox will contain the core part of the Odin Service Automation hosting system and optional components on your choice. This option is preferable when you go through practical steps of developing sample packages.

Get ready APS Development Environment

APS packages can be created on local computers. Assuming that you will use Windows, Linux, or Mac OS, we recommend you to install the following development tools on it.

  • To build and validate APS packages, install Development Tools relevant for your local OS.
  • To be able to use APS PHP runtime library, install APS PHP runtime on your computer. It allows you to use multiple REST and APS specific methods to eliminate development of own low level communication and security methods.

Follow Demo Integration Process

You can follow the step-by-step demo integration processes to get skills in integrating a cloud application with a hosting system based on Odin Service Automation. During this process, you will be able to go through all steps of the package life cycle.

  • Analyze the business logic of the application to decide which resources it will provision to customers.
  • Develop APS packages starting with the simplest project that will make you feel how APS works. You will proceed with adding new features in the subsequent projects. You will be able to develop type schemas, provisioning scripts, and custom UI.
  • Test deployment and provisioning of your packages on the hosting system. You will try and debug the packages, as well as verify how the application services will look for customers.

Start your own Project

Keep in mind the following key points once you started integration of your application.

  • Specification is the main official APS document you need to follow in your project to ensure your package complies with APS.
  • During the development process, you most probably will need to refer to the following libraries the APS team provides for you.
  • You can validate and debug your custom UI in the APS Fiddle before building your package. The tool is described in the APS Fiddle section.

Sample Packages

The following packages can be used as samples for creating your own packages by simply copying and modifying any parts of them.

  • Resource Management Tool is useful as a debug tool. It detects and displays all provisioned APS resources and other APS properties available for the user logged into a control panel of a hosting platform.
  • Sample ownCloud Application illustrates a real production system. It allows you to provision cloud storage for customers and their end-users.

A set of demo projects illustrates the step-by-step package development process using Odin Service Automation as a hosting platform:

  • Starter contains only minimal set of elements that each package should include.
  • Basic demonstrates custom UI for provisioning and managing virtual private servers (VPS).
  • Service User Wizard shows how to integrate with the Service Automation service user wizard to assign application services to end-users.
  • Offering Management includes custom UI for the provider to configure VPS offering.
  • Resource Consumption Monitoring demonstrates how to periodically request resource usage data from an application.
  • Upsell Processing shows how to integrate with the Service Automation billing system to upsell application resources.
  • Offer-Counter-User Management is a complex project that allows providers to include their offers in service plans, assign resources to end-users, and collect actual resource usage data.
  • Event Processing contains a special service subscribed to different event types for monitoring in real time information about creating, deleting, and changing resources.
  • VPS Backup Integration illustrates a way of integrating two different applications through APS API.