Previous topic

SDK Overview

Next topic

Using APS REST API

Odin Automation SDK
Last updated 25-Sep-2017

Using Platform Services

Service providers may have their own management systems (accounting, billing, and other) that must use the platform services and other cloud services. This is possible by means of the APS API exposed by the platform through the APS controller. This document helps service providers and system integrators monitor and manage the platform services and applications integrated with the platform. It explains scenarios with step-by-step instructions on achieving typical management goals.

Structure and Authentication

The APS controller functions as the message broker incorporating all APS participants on the APS bus into an APS ecosystem.

../_images/system-integration.png

APS security model allows two types of sender authentication on the APS bus:

  • Via an account, user, or subscription token usually obtained through one of the control panels (PCP, RCP, CCP, or MyCP). This document will explain how to use a security token when sending REST requests through the APS bus.
  • Via an SSL certificate that the APS controller generates for APS application instances. This method is used by APS application services deployed and provisioned on the platform.

Typical Management Procedure

Typical activity on the APS bus we are going to discuss in this document includes the following steps to reach a management goal:

  1. Get a security token from the platform.
  2. Send a necessary REST request for the required service through the APS controller.
  3. Process (sometimes, just analyze) the response from the APS controller.
  4. Proceed to the next action starting from step 1 if you need to update the token or otherwise from step 2 until you achieve the management goal.

Scenarios

The first document in this set Using APS REST API explains how to send REST requests using a UI tool or the cURL service. You should be familiar with this technique before you get started with the scenarios explained in the other documents.

There are two groups of scenarios: service management through the OSS (operations support system) and product management through the BSS (business support system). The first group is based on APS REST requests for the platform operations and for services provided by some cloud applications integrated with the platform. For this group, we assume the platform consists of the OSS only. The group is presented by the following scenarios:

  • Provide Services to Users is the most complete end-to-end and step-by-step scenario including creation of customers and users, configuration of the service plan and creation of a subscription, and then assignment of an application service to service users.
  • Provide DNS Services to Customers explains a short way of providing the DNS services to customers.
  • Get Resource Consumption presents typical REST requests that an external management system can use to get resource consumption in a specified subscription.

The last scenario Manage Prices is currently the only one in the second group that requires to have both parts installed, OSS and BSS. It illustrates a process of updating prices in service plans and synchronizing them with resellers.