Skip to main content
All CollectionsApp Support
Create a private app
Create a private app

This article summarizes the required steps to create your App as a private for one or more specific stores.

Updated over a year ago

Requirements for Private App Installation:

To install the app as a private application, it is required that the targeted store be on a professional package. If the store is not currently on a professional package, the alternative option is to purchase the API Access add-ons. This ensures a seamless integration process and access to the full functionalities of the private app.

To create a new application, follow these steps:


  1. Open the dashboard

  2. Navigate to My Apps

  3. Click Create Application button.

  4. Fill in the basic information for your application

    • Application Name: The name of your App which 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.

  5. Click 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

  1. Redirect url (Ask for merchant permission)

  2. Callback Method (Get the tokens)

  3. 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

  1. Application links:

    • Redirection URL, to read more about this URL click here

    • Callback URL: to read more about this URL click here

  2. 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 this will be shown to the merchants in the App page.

  1. Application Video: We support only embed Youtube video URL with this format: https://www.youtube.com/embed/######

  2. Applications pictures and screenshots: These will be shown and appear to the merchants in your App page

  3. Application Icon: Your App logo.

  4. 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

Installing the app

Once your app is prepared for installation, please connect with our team to share the store URL. Our team will then proceed to install the app privately for you. Feel free to reach out through our dedicated support channel for prompt assistance.

Did this answer your question?