To create a new application, follow these steps:
Open the dashboard
Navigate to My Apps
Click the Create Application button.
Fill in the basic information for your application
Application Name: The name of your App that will appear to the merchant."make sure of write App name in Arabic and English Language"
Application URL: Your main company website. started with "http://"
Application Category: Define your service category.
Application Language: Supported languages in the system.
Maintainer E-mail: The responsible email to receive and reply to the issues.
Click the Create Application button to move to the next step.
General Settings
This page displays your OAUTH 2.0 and your App ID (Client ID) and Secret key.
Implement OAuth 2.0
Redirect url (Ask for merchant permission)
Callback Method (Get the tokens)
Refresh tokens
OAUTH 2.0
If you are not familiar with OAUTH 2.0 or you need more information about OAUTH 2.0, redirection or Callback, please check our Authorization Documentation.
Explore our APIs
Scope Selection
Select the App permissions from the Application scopes section. Check the radio buttons of each App permission that you want to use. When you submit your application to be published, our team will review the selected scopes and notify you.
Application Details
Application links:
Redirection URL, to read more about this URL click here
Callback URL: to read more about this URL click here
Application Description:
Long Description:
App Definition
App services
App Features
Short Description:
Include a brief of your App services.
Developed by: Your main company name will be shown to the merchants in the App page.
Application Video: We support only embedding Youtube video URL with this format: https://www.youtube.com/embed/######
Applications pictures and screenshots: These will be shown and appear to the merchants in your App page
Application Icon: Your App logo.
Application Testing
Download your app on your development store
Webhook Management
Next Step is to add a webhook. through this screen, you can add new webhooks, delete or edit your added ones. You can perform this action while creating your application, or later.
Webhooks
For more information about webhooks, check our technical references Section
Plans Management
For public App you can add maximum of four plans to the application with features and description details.
Note
The plans will be displayed to the merchants in the same order in which they are created.
Plan Types
Following are the available plans that you can provide for subscription:
Free:
This is a free-of-charge plan, as the user can install the application without incurring any charges and the duration for use is indefinite period.
Subscription plans:
This is a PAID plan, as you can specify the amount required to be paid based on the features offered for 1-12 months.
Subscription plan options.
Duration: you can simply choose when this plan will expire, with x months "12 months is a maximum". Ex: when Duration = 4 months, the plan will expire after 4 months ended.
Add an offer on the duration of the plan:
this feature will enable you to add an offer on the duration of a plan. For example, you can now set up offers such as "Subscribe for a year and get X months free" or "Subscribe for X months and get Y months free."
Description: this should be a line description with a brief definition of the plan.
Price: Minimum price: 1 SAR, Maximum price: 120000 SAR
Trial available: Minimum Days: 1 day, Maximum Days: 90 SAR
Features: up to 5 features
Activate recurring subscription: This option will appear to the user when subscribing to the Plan.
Manage your subscription
To know more about how to manage your subscriptions click here.
Subscription Statuses:
Subscription Webhooks
Subscription Events