Mini Program Plugin Introduction

Plugins are functional components that can be added to and directly used in Mini Programs. Developers can develop plugins in a similar way as Mini Programs for other Mini Programs. Mini Program developers can also use plugins within Mini Programs, eliminating the need for redevelopment and making it possible to provide users with more diversified services.

If you want to develop and use a plugin, read the Developing plugin and Using plugin sections respectively.

Developing plugin

Applicable scope and service categories

Applicable scope: Mini Programs of companies, media, governments, and other organization entities

A developer can select one of selected categories of the Mini Program account as the service category of a plugin. The following lists currently available plugin service categories. More categories will be on offer over time.

Primary Category Secondary Category Special Notes
Express delivery and postal services All secondary categories
Education All secondary categories
Medical Medical services and Internet hospital Medical Mini Program only
Government and civil affairs All secondary categories
Financial industry Credit information operations and insurance
Travel and transportation All secondary categories
Daily life services Ticket service, bill payment, and entertainment
IT and technology All secondary categories
Catering Reviews and recommendations, recipes, queuing in restaurants, meal ordering platform, and take-out platform
Tourism All secondary categories
Cultural recreation Video, FM/radio, music, audio books, and comics and animation
Tools Bookkeeping, voting, calendar, weather, memo, office, dictionary, calculation, quotation/price comparison, invoice inquiry, business management, appointment/registration, pictures/audios/videos, and information inquiry
E-commerce platform E-commerce platform
Social Note-taking, FAQ, community/forum, and chatting with strangers Social Mini Programs only
Social Live broadcast E-commerce platform and education Mini Programs only
Commercial services Recruitment/Job search
Automobile All secondary categories

Plugin development access process

Below lists the plugin development access process:

  1. Enable the plugin function
  2. Enter development information and develop the plugin
  3. Complete basic information
  4. Editing and upload of a plugin development document
  5. Usage application management

Enable the plugin function

Mini Program developers can enable the plugin function on the Mini Program Backend Manager without registering a new account. The function is enabled after basic information is completed.

Entry of enabling: Mini Program Plugin on the Mini Program Backend Manager

Enter basic information about a plugin. Such basic information will be displayed during the plugin application process and on the Mini Program basic information page.

Enter development information and develop the plugin

You can develop a plugin on a developer tool after setting plugin information such as a server domain name and token.

For more information about settings in developer tools, see the Plugin Development Guide.

Complete basic information

Before submitting a plugin for review, ensure that the plugin name, profile photo, profile, and other information has been set and a plugin development document has been uploaded to facilitate plugin access.

Completion of basic information

Log in to the Mini Program Backend Manager and choose Mini Program Plugin > Basic Settings to ensure that information such as the plugin name, profile photo, profile, following method, and customer service contact information is complete.

Editing and upload of a plugin development document

Plugin developers can upload and release plugin development documents to enable Mini Program developers to quickly access plugin services.

(1) Editing

In addition to plugin code, a Mini Program developer can upload a plugin development document. This document must be placed in the doc directory of the root directory of a plugin project with the structure as follows:

doc
├── README.md   // Plugin document, in Markdown format
└── picture.jpg // Other resource files. Only images are supported.

Referenced image resources cannot be Internet images and must be placed in the directory.

(2) Upload

After editing README.md, you can preview or upload a plugin document in a developer tool.

Entry of uploading: lower right corner of the README.md file

(3) Release

A document will not be released immediately after you upload it in a developer tool. You can log in to the Plugin backend manager with your account name and password and preview and release a plugin document in Mini Program Plugin > Basic Settings.

A released plugin document can be repeatedly modified.

Plugin version management

Developers can upload code within developer tools and develop and debug plugins within the Mini Program Plugin Development Assistant. Note: Plugins cannot be used in the experience version.

After uploading code in a developer tool, a developer can manage plugin versions in Mini Program Plugin > Development Management on the Mini Program Backend Manager.

A plugin must be submitted to the WeChat Mini Program team for review and can be released only with its approval.

Before submission, a plugin developer must enter the following information: plugin service categories, labels, previews, and feature descriptions.

Plugin service category: One of approved Mini Program service categories can be selected for a plugin. For available categories, see the Applicable scope section.

Label: Enter a label associated with the service provided by a plugin.

Preview: You can upload a preview of a plugin so that it will be displayed on the plugin details page to help users understand plugin functions in advance.

Function description: Developers should provide basic introductions and plugin instructions to make it easier for the review team to review plugin functions.

Usage application management

A developer can handle plugin access applications in Mini Program Plugin > Application Management on the Mini Program Backend Manager. A plugin developer can choose to "approve" or "reject" plugin usage applications within 24 hours.

Plugin payment function introduction

The payment capability is available within a plugin to help plugin developers provide closed loop services.

The access process is as follows:

(1) Enable the WeChat Pay capability for the Mini Program where a plugin is located. For more information, see the Guide on How to Enable WeChat Pay for a Mini Program

(2) Select an appropriate payment model by referring to the table below according to usage scenarios

Payment Mode Applicable Scope Typical Usage Scenario Access Process
Service provider A plugin involves providing vendors with services such as sale of goods and fee collection. In other word, products for sale are not provided by plugin developers. An e-commerce platform provides shelves, shopping carts, and services for vendors, while a catering platform provides meal ordering and payment services for offline vendors. 1. Apply to become a WeChat Pay service provider. For more information, see the WeChat Pay Service Provider Function Introduction and WeChat Pay Service Provider Access Guide.
2. Create a sub-vendor account for a vendor.
3. Bind the sub-vendor account and the account of the Mini Program where a plugin is located. For more information, see the Development Documentation.
4. Use a sub-vendor account to initiate payment within the plugin.
Ordinary vendor Paid services/products offered in plugins are produced and sold by plugin developers. Provide information about existing online services (including but not limited to information about the official account, website, application, and Mini Program) and certificates of production and sale of self-operated products such as purchase invoices on the plugin payment application page.

(3) Submit a plugin payment capability application on the plugin backend manager to use WeChat Pay capability within plugins after approval.

Using plugin

Mini Program developers can easily add plugins to their Mini Programs to diversify Mini Program services. This allows Mini Program users to use services provided by plugins within Mini Programs.

Applicable scope

All Mini Programs

Access Process

  1. Add a plugin on the Mini Program Backend Manager

    A Mini Program developer can search for a desired plugin and apply for permission to use it in Settings > Third-Party Service > Plugin Management on the Mini Program Backend Manager. The developer can use the plugin within the Mini Program if the plugin's developer approves the application within 24 hours.

  2. Use a plugin in Mini Program code

    For more information, see the Plugin Development Document.