Create an Application on Subscripto
Creating an application is the main purpose of partners to benefit from the Subscripto platform. Once you are registered, you open up your application to our user base to spend their credit using your application. This section outline how to create an application and the specific values/settings that may be important during the setup.
Before you start
To create an app with Subscripto, you must firnst register with Subscripto as a Partner and complete your account setup.
Overview
Once you have registered as a partner, you will need to register an app to be able to:
- Enable integration: Start the integration of the "Login with Subscripto" button with your application
- Manage Permissions: You can select the permissions and features your application will request the user to agree to when tey sign up to your application
- Obtain user credentials: Each application will have its own Application ID and Application Secret, which is needed for authentication and authorisation for generating an access token for the application
Permission and Features use cases
Use cases define the available options that Subscripto will allow your application to interact with our platform and also the users that register with your application.
When you add a use case to your application, the features, permissions are displayed to the user for acceptance when they register with your application. For example, if you select application_billing, this will enable the application to perform billing requests for actions taken in their application.
You can add multiple use cases as required by your application, provided it makes sense for your application.
Our existing use cases
Permissions
| Property | Description |
|---|---|
| account_email | The application may want your email address for certain usage |
| account_phone | The application may want your phone number for certain usage |
| account_credits_read | Enable the application the check your remaining |
| account_credits_charge | Enable the application to charge your credits (usually for in-app purchases) |
| account_pay_as_you_go | Enable the application to bill on a pay as you go purposes) |
| account_notifications | Enable the application the send notifications (via Subscripto Partner API) |
Features
| Property | Description |
|---|---|
| application_in_app_billing | Enable in app billing |
| application_submit_metered_usage | Enable the application to submit usage information |
| application_marketing | Enables the application to send you marketing message |
| application_notification | Enables the application to send you notification message related to the application |
What are permissions and features
Permissions are how the application asks someone if if can access their data stored on the Subscripto platform.
To be deleted
To integrate your application with our platform, you need to create a partner account
Make sure to enter details correctly as this will be displayed to users during the sign up phase.
If you wish to join us as an early adopter or beta tester, please get in touch with us.
Terms and Conditions
Review the Subscripto platform Terms and Conditions and Privacy Policy on our main website which outlines how to use the application. We have these available as a PDFs: Terms and Conditions PDF and Privacy Policy
Verify your account
Once you have created your account, you will receive an email to verify the creation of the account. There are various step to following, which we will cover in the following sections:
Next Steps
Now you have created your account, you should register your first application.
Applications Properties
SUBSCRIPTO_CLIENT_ID=019967ac-b2ce-7231-92c4-592e2da195c0
SUBSCRIPTO_CLIENT_SECRET=6rrRw9h0pFrAB5MbX5gR4A2lMJgEykMRYxepVrBE
SUBSCRIPTO_REDIRECT_URI=https://yourapp.com/auth/subscripto/callback
SUBSCRIPTO_OAUTH_SERVER_URL=http://localhost:8000
SUBSCRIPTO_SCOPE="app_provider_billing account_details"
We have
| Property | Description |
|---|---|
| SUBSCRIPTO_CLIENT_ID | Your Client ID that indicate the application |
| SUBSCRIPTO_CLIENT_SECRET | The Client Secret for your application |
| SUBSCRIPTO_REDIRECT_URI | Where should our OAuth server redirect to |
| SUBSCRIPTO_OAUTH_SERVER_URL | The OAuth server - usually subscripto's server auth.getsubscripto.com |
| SUBSCRIPTO_SCOPE | This is the scope of access you application will request from the user |
| Paragraph | Text |
Applications scope permissions
Permissions lets you request information from Subscripto about the user they have given to us. Some permission relates to features such as enabling metered billing/confirmation, In-app billing. Other permission relate to sharing data such as Email, Telephone number. You can indicate some requested permission as optional, to ensure that users can proceed if they feel the need not to share such information
| Permission | Description |
|---|---|
| Request that the user shares their email address when signing up. This could be for emails from your application | |
| phone_number | Request that the user shares their phone number. This can be for notification via your application |
| account_details | |
| biling_in_app_billing | |
| billing_metered_billing | |
Add Markdown or React files to src/pages to create a standalone page:
src/pages/index.js→localhost:3000/src/pages/foo.md→localhost:3000/foosrc/pages/foo/bar.js→localhost:3000/foo/bar
Create your first React Page
Create a file at src/pages/my-react-page.js:
import React from 'react';
import Layout from '@theme/Layout';
export default function MyReactPage() {
return (
<Layout>
<h1>My React page</h1>
<p>This is a React page</p>
</Layout>
);
}
A new page is now available at http://localhost:3000/my-react-page.
Create your first Markdown Page
Create a file at src/pages/my-markdown-page.md:
# My Markdown page
This is a Markdown page
A new page is now available at http://localhost:3000/my-markdown-page.