Previous topic

SDK Overview

Next topic

Using APS REST API

Odin Automation SDK
Last updated 16-Jan-2018

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 the following types of sender authentication on the APS bus:

  • Via an account, user, or subscription token obtained automatically through one of the control panels (PCP, RCP, CCP, or MyCP).
  • 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.
  • Via the OAuth protocol as explained in the Using APS REST API document that follows this one.

Note

The latter of the above-mentioned authentication methods is the most relevant for external management systems.

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 security credentials 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 temporary credentials or otherwise from step 2 until you achieve the management goal.

Scenarios

The first document in this set Using APS REST API contains some advices on using a REST client. You should be familiar with this technique before you get started with the scenarios explained in the other documents.

The other documents are instructions and examples on doing typical operations with the platform and applications. You can combine those operations into your own business scenarios.