Skip to main content

How to start with integrations

Congratulations,
if you have met the prerequisites, you can continue with the integration of your applications.

If you are developing an external cloud application and wish to sell it through AVAstore, you must implement the process of automated order approval and deployment of your applications after they are purchased by the customer, the so-called “Business Integration” process. When you choose to use the Pay-as-you-go billing model, you need to implement logic to provide usage data for billing service.

If you also want to provide automated data transfer between your application and other applications purchased by the customer, you must implement the “Data Integration” process using Virtual Data Models (VDM).

See also:

Prerequisite checklists for integrations​

Checklist of what should already be completed before proceeding further:

Checklist F1 – Partner tenant onboarding

Checked stage: alpha.avaplace.com

To run the checklist, you need to sign in

Business Integration​

Purpose: automation of order approval and deployment of external cloud applications after they are purchased by the customer.

How to start - Business integration

Click to expand

Create an implementation of the integration bridge between deployment infrastructure of our applications and AVAplace platform. So called business integration agent.
See also: Order model - general principles for maintaining compatibility

Summary of implementation steps:

  • obtain service account of your external application for your business integration agent
    • note: the business integration process is using tenant context of application vendor and a single service account (the partner selects the account of one of their apps)
  • register message-gateway consumer for your business integration agent
    • note: tenantId of your application vendor must be used as unique identifier of your consumer
  • implement consumer(s) for requested PlatformStore notifications using gRPC or Webhook technology
  • implement requested PlatformStore.Order API methods to get order details and set order status with respect to status flow

AVAstore application (FE) to test the business integration process by purchasing the application. When the application’s vendorCode matches the customer’s tenantId then the testing bypass process is used that ignores the business constraints and allows developers to repeatedly order the application and tune the integration; this applies to all stages including PROD.

Data Integration​

Purpose: automation of data transfer between native and external applications (including ERP) using VDM.

How to start - Data integration

See also: VDM - reference book

Click to expand

Create an implementation of the integration bridge between our application and AVAplace platform. So called data integration agent.

Summary of implementation steps:

  • obtain service account of your external application for your data integration agent
    • note: the data integration process is working in the customer's tenant context accessible for the service account of the application
  • register data integration agent (in master context)
  • register message-gateway consumer for your data integration agent
    • note: global application code of your application must be used as unique identifier of your consumer
  • configure data integration agent and its consumer (in tenant context)
  • implement consumer(s) for requested DataService notifications using gRPC or Webhook technology
  • implement requested DataService API methods to consumer or publish data using REST API