Product integration settings

In the Integration section, you can select and configure the provisioning mode of your product. Also, you can check integration of your API service with the ActivePlatform ecosystem.

In this section:

Select and configure the provisioning mode

To select and configure the provisioning mode of your product:

1. On the Product Dashboard, click Integration. The Integration section is displayed.
   
   
   
   

2. Select the appropriate provisioning mode:

   • Manual — all operations with customers' subscriptions to your service (creating, stopping, activating, renewing) require manual actions on the service side. For every operation, an email notification will be sent.

   • Automatic — all operations with customers' subscriptions to your service are performed automatically using the API service (see also Events handling on the vendor service side).
3. For the Manual mode, in the Email field, enter the email that Vendor Portal uses to send notifications on provisioning operations.
4. For the Automatic mode:
   1. Configure the following toggles:
      
      • Allow order attributes: turn it on if your product uses order attributes (see Order Attributes. Attributes Validation).
      • Allow usage url: turn it on if your product supports checking the current amount of resources in use. If the toggle is on, ActivePlatform calls the Subscription Usage Statistics notification URL to get the current amount of resources in use on the service side.
      • Allow consumption url: turn it on if your product uses the Pay as yo go model to charge customers for consumed resources. If the toggle is on, ActivePlatform calls the Subscription Consumption notification URL to collect information about the number of consumed resource units on the service side and calculate the charge amount using the resource unit prices stored on the platform side.
      • Allow resource validation: turn it on if your product supports checking the new amount of resources against the current in use on the service side to allow or deny updating a subscription. If the toggle is on, ActivePlatform calls the Subscription Resource Validation notification URL to validate the new amount of resources and prevent updating a subscription with any unallowed amount of resources (see Subscription Resource Validation).
   2. In the API path field, enter the base URL for requests to your API service. 
      
      
      
      
5. When you finished, select your next step:
   • To continue configuring the product and go to the next section, click Save & Continue.
   • To return to the Product Dashboard, click Save and then click Go to Product Dashboard.
   • To test the Automatic mode, click Save and see the Check API integration chapter below.

Check API integration

For the Automatic mode, after clicking the Save button, the Integration section is displayed with the integration check group.

To check the integration of your API service with the ActivePlatform ecosystem, click Start check. The check endpoint URL {api_path}/check?ap_guid={ap_guid}&reseller_id={reseller_id} is generated and queried automatically using the provided base URL as {api_path}:

• If the API service successfully responses, the following message is displayed: Your integration is ready to use. Select your next step:

  • To continue configuring the product and go to the next section, click Save & Continue.
  • To return to the Product Dashboard, click Save and then click Go to Product Dashboard.

  Passing this single endpoint check assumes that all other endpoints required for your product also work correctly with the same base URL (see Events handling on the vendor service side):

  The list of endpoints

  • The following endpoints are mandatory (service integration will not work correctly if these endpoints do not work):

  • • Subscription Create is called when a customer purchases a new subscription.
    • Subscription Update is called when a customer performs any operation with the subscription (changes the subscription resources, switches the subscription plan, renews the subscription, etc.)
  • The following endpoints are optional:
    • Subscription Renew — this endpoint is called when subscriptions are renewed (see Subscription Renew).
    • Subscription Activate — this endpoint is called when subscriptions are activated (see Subscription Activate). 
    • Subscription Deactivate — this endpoint is called when subscriptions are deactivated (see Subscription Deactivate). 
    • Subscription Delete — this endpoint is called when subscriptions are deleted (see Subscription Delete).
    • Subscription Resource Validation — this endpoint is called for checking the new amount of resources against the current in use on the service side to allow or deny updating a subscription.
      
    • Subscription Consumption — this endpoint is called within the Pay as yo go model to collect information about the number of consumed resource units on the service side.
      
    • Order Attributes — this endpoint is called to request additional data when customers purchase subscriptions through ActivePlatform (see Order Attributes. Attributes Validation).
    • User Create — this endpoint is called when a user was created in ActivePlatform (see User Create).
    • User Update — this endpoint is called when a user was updated in ActivePlatform (see User Update).
    • User Delete — this endpoint is called when a user was deleted in ActivePlatform (see User Delete).
    • User Activate — this endpoint is called when a user was activated in ActivePlatform (see User Activate).
    • User Deactivate — this endpoint is called when a user was deactivated in ActivePlatform (see User Deactivate).

    • User Password Reset — this endpoint is called when the user's password was reset in ActivePlatform (see User Password Reset).

  If the base URL for requests to your API service is changed after the product publication, it is necessary to update information in the Integration section and publish the updated product version (see Update a product).

  
  
  
  

• If you got any errors, fix them and then click Start over to check the settings one more time.