Introduction

Understanding the Authorization Model

APIs Used for the Integration

Integrating Subscription Model

Integrating the Onetime Payment (PPV) Model

How to Integrate Webhook

Introduction

Integrating external (third-party) billing system with Muvi allows you to seamlessly manage your content and user authentication from Muvi's platform while utilizing your own billing engine and user management system. This integration provides you with the flexibility to create subscription plans, pay-per-view (PPV) options, and other monetization models within the Muvi platform.

To get started, you can leverage Muvi's Login/Registration APIs to create users in your Muvi apps. This ensures a smooth user experience as users can easily sign up or log in using their credentials from your existing user management system. Once users are registered or logged in, you can utilize Muvi's comprehensive set of features to manage content and subscriptions.

Understanding the Authorization Model

Before accessing any of the Muvi APIs, you need to understand about authorization model. For authentication, the Access token must always be passed in the header as an Authorization bearer token. For more details, please check the help article.

APIs Used for the Integration

We are using two types of APIs.

1. REST API (used for data writing)
2. GraphQL API (used for data read access)

The following key points are applicable for both types of APIs.

API Endpoint: https://apigateway.muvi.com

Method: POST

Header: Content Type: application/json

Authorization: Bearer Token

Parameters with asterisk (*) marks are compulsory.

Body parameters should be passed in the JSON format.

In the case of REST API, you will have to pass the request parameters with key-value pair, whereas in GraphQl API, you will have to mention the response parameters in the query request.

We have the following global parameters:

app_token: This is a unique identification key for an application.

product_key: This is a unique identification key for a product.

store_key: This is a unique identification key for an account. This is only applicable (Mandatory) for the Muvi One product.

user_uuid: This is a unique identification key for a user.

In the case of GraphQL API, you must pass the value by appending a colon (:) like below...

Eg: app_token: \":app_token\". product_key: \":product_key\". store_key: \":store_key\". user_uuid: \":me\"

Integrating Subscription Model

The subscription model describes a user who must pay a fixed amount at regular intervals for access to content. This module covers the following events.

• Onboarding

The Onboarding API facilitates a frictionless user initiation process by enabling seamless interaction between the external vendor's platform and the Muvi system. Developers can leverage the API to effortlessly onboard users onto their subscription service, ensuring a smooth and user-friendly experience.

• Recurring

Automate the recurring billing process with Muvi's platform. This essential module synchronizes billing cycles between the external vendor's system and the Muvi platform, ensuring uninterrupted service for subscribers. Developers can integrate this API to streamline periodic transactions and maintain a seamless flow of subscription services. In this process, the payment will. 1) Success 2) Fail.

In case of Success payment, the billing date will be changed to another term that a user has taken, whereas in case of the failure of the payment, the subscription will terminate right away, and that user will not be able to access the content any longer.

• Cancellation

The cancellation process provides a straightforward mechanism for users to discontinue their subscriptions. Developers can implement this API to facilitate a user-friendly cancellation process, ensuring synchronization between the external vendor's platform and the Muvi system.

The cancellations can happen in three ways.

1. The user cancels himself/herself.
2. Admin can cancel the user’s subscription.
3. The system cancels when the recurring payment fails.

Integrating the Onetime Payment (PPV) Model

This model allows you to watch content for a limited period after taking a payment. In this case like a subscription, you need to handshake the billing detail of the user with Muvi’s ecosystem.

How to Integrate Webhook

By integrating webhooks with your payment gateway, you can automate responses to various payment-related events. This ensures that your system remains up-to-date with real-time information regarding transactions, subscriptions, and refunds. Following these steps will help you efficiently manage these events and provide a seamless experience for your users.

• Log in to the Payment Gateway site
• Go to the Dashboard and navigate to Developers --> Webhooks.
• Type the following codes