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.
Embed application
Give merchants the ability to access the app directly from their dashboard, click here to view the documentation.
Example:
Custom Snippets
Add custom HTML and JavaScript snippets to stores using your app.
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
The next Step is to add a webhook. through this screen, you can add new webhooks, and 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
You can add a 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.
Recurring:
You can add a maximum of 4 subscription plans so that ZId merchants can benefit from the features of your application by subscribing to one of the plans.
Plan Details
Plan Name (*)
English / عربي: The name of the plan in both English and Arabic.
Duration (*)
Defines how long the plan lasts (e.g., monthly, quarterly, yearly).
Description (*)
English / عربي: A short explanation of what the plan includes.
Features (*)
English / عربي: A list of key benefits or features included in the plan.
Pricing & Trial
Price Plan (SAR) (*)
Defines the cost of the plan in Saudi Riyals (SAR).
Trial Available (Days) (*)
Specifies if a free trial is available for this plan and for how many days.
Additional Fees
One-time fees
Defines any extra charges that are only applied at the first-time installation of the app.
Offers & Discounts
Add Plan Offer
Allows you to create an offer for the plan (e.g., discount, Buy X get X).
Usage-Based Subscription
Charge merchants based on their app usage with flexible pay-as-you-go pricing options to suit various strategies.
Plan Details
Plan Name (*)
English / عربي: The name of the plan in both English and Arabic.
Description (*)
English / عربي: A short explanation of what the plan includes.
Features (*)
English / عربي: A list of key benefits or features included in the plan.
Usage Type
Emails
Messages
Calls
Orders
Other
Initial Cost (*)
Include the integration and setup fee prior to usage-based charges.
Manage your subscription
To know more about how to manage your subscriptions click here.
Subscription Statuses:
Subscription Webhooks
Subscription Events