The IM Account Server

Introduction

The Informatics Matters Account Server (AS) is an early prototype service designed to manage and administer Product Subscriptions required by our IM-related Merchants, which include the Data Manager. It allows services to query products, authorise billable Actions (like running Jobs or storing files) and then bill for those actions.

It is important to understand that the AS is just one component in a larger monetization solution.

In our design, monetization of billable services consists of software that falls into three broad functional areas, as illustrated in the following diagram: -

  1. Billable Services

  2. Account Management (including the Account Server)

  3. A Payment Infrastructure

_images/im-as-diagrams.001.png

Today…

We have a Merchant that is the Data Manager and a working prototype Account Management solution - one that permits the creation of Product Subscriptions and has a private (merchant-facing) API to allow merchants make calls into the AS to claim, authorise and charge for billable activities.

The AS also exposes a public (customer-facing) API that lets users create and delete Products and view the current and predicted billing costs.

We’ll discuss these working aspects of the solution later.

We do not have a customer-facing GUI for the management of Products, Organisations, Units or Users (though that can be done through the Swagger UI) and we do not have a Payment Infrastructure.

Have developed the AS so that it’s at a stage where it can function as an authorisation and billing mechanism for our services - the Payment Infrastructure, for now, is not required.

Realisation

The AS is a containerised application that’s deployed into a Kubernetes cluster using an associated Ansible Role that can be found in our account-server-ansible peer project.

It offers two independent REST interfaces - one interface that’s attached to a public Ingress (intended to be used by customers) and one that’s private, attached to a Service (that’s only available to services co-located in deployment cluster).

_images/im-as-diagrams.002.png

The public API provides Users (and IM Administrators) with the ability to: -

  • Create Organisations (Admin users only)

  • Create Units (these are groups within an Organisation)

  • Manage (create and delete) Users within Organisations and Units

  • Manage (create and delete) Product Subscriptions (that belong to Units)

  • Manage Assets (text-based material)

  • View Billing

The private API provides merchants with the ability to: -

  • Claim claimable subscriptions (given a product)

  • Release claimable subscriptions (given a product)

  • Pre-authorise billable actions (against a unit or product)

  • Charge for billable actions (using a unit or product)

  • Acquire assets to use within the services of the merchant

Contents: