Skip to main content
SubscriptionFlow Docs
API

API Integration Guide

Updated

API Integration

SubscriptionFlow API

SubscriptionFlow provides flexible APIs that developers can consume according to the requirements of business system integration. The REST API of SubscriptionFlow presents an array of operations and resources that help you ensure production efficiency through web integration from your website. It allows you to create dynamic API endpoints for custom modules that can be used to automate the entire business workflow.

For more information, visit the Developer’s Portal.

OAuth v2.0

SubscriptionFlow uses OAuth v2.0 to authenticate the REST API. Authentication through OAuth involves three steps:

  • Create a customer: The first step is to create an OAuth customer in SubscriptionFlow. With this, customer ID and customer secret will be generated.
  • Generate token: A token is generated that can be used until it expires. A new token needs to be generated if it gets expired.
  • Authenticate API Requests: The bearer token generated in step 2 is used to authenticate API requests.

Base URLs

SubscriptionFlow defines base URLs specific to the company’s domain. The domain of your company would be the base URL. For example, yourorg.subscriptionflow.com. Similarly, the REST endpoint will be yourorg.subscriptionflow.com/api/v1/

*Here v1 refers to version 1 which can be changed according to the version that is been used.

Pagination

The paginated data will be returned as JSON responses with enough metadata to handle the bulk of records. It helps you filter out and sort the complex data. A standard format is used by API for responses across the system.

 

Happy Subscription Management!

Was this article helpful?0 out of 0 found this helpful
Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.