# Management tools

WeChat official in order to help service provider developers can focus more on business development, Reduce the cost investment in environmental construction, management tool construction and other projects, and launch the function of "one-click to build third-party platform back-end services and one-click to obtain third-party platform management tools," helping service providers to conduct business more efficiently based on third-party platforms.
The "third-party platform back-end services" that are iterated by the official maintenance and the "third-party platform management tools" named [Service Provider Manager] are collectively referred to as "third-party platform cloud services," which are open in the form of mirrors and source code. Developers can get out-of-the-box back-end services and service providers SAAS applications (service provider butler), and can also be developed with the service provider business docking.
The service is deployed with One Click onWeChat cloud hostingThe source code address iswxcloudrun-wxcomponentDevelopers can download the source code for secondary development.
If you have any problems with this function, go toWeChat Open Platform Service Provider ZoneFor feedback.
You can also write privately.Third Party Platform AssistantNeed feedback and join the exclusive communication group, please note to join the third party platform management tool communication group.

# I. Introduction to Functions

# 1. List of functions

The latest version of this tool is v 2.1.0 The functions are as follows, subsequent versions will provide more comprehensive authorized account life cycle management related functions, if there is more demand feedback can be privately sent to find out.Third Party Platform AssistantFor feedback.

Authorized account management: can be authorized to the third party platform Official Account message template/Mini Program account for visual management.
On behalf of the development of Mini Program management: can submit code, submit audit, submit the release and other operations.
Third-party token acquisition: can get the component with one click_verify_ticket、component_access_token、authorizer_access_Token and WeChat token, easy for developers to debug.
Third party message view: You can get the message pushed to the authorized event URL and the message and event URL with one click, which is easy for developers to debug.
Third party authorization page generation: can generate PC version and H5 version of the authorization page, merchants can scan the code or directly access the authorization page to complete the authorization.
Message Repeater: It can forward the messages received from WeChat official push to the service provider's business services, and realize the integration with the business system.
Proxy configurator: The external request is forwarded to the service provider business service through the transmission, so as to achieve the micromanager and other business systems docking.
Exclusive Technical Support Group: Visit the home page of Micro Housekeeper to scan the code to join the official communication group and get technical support.

# 2. Terms of Use

# 2.1. Get tickets and tokens

The module provides one-click access to component_verify_ticket、component_access_token、authorizer_access_Token and WeChat token functions, easy for developers to debug. However, if the third-party platform does not use the default configuration generated after the deployment of the cloud service, it will affect the use of relevant features. As follows:

If [Authorization Event Configuration] does not use the system-generated environment id, service name, and message path, component cannot be retrieved in the third-party platform management tool with one click_verify_ticket。
If [Authorization Event Configuration] does not use the system-generated environment id, service name, and message path, component cannot be retrieved in the third-party platform management tool with one click_access_token。

# 2.2 Viewing messages and events

This module provides a one-click access to push to the authorized event URL and message and event URL function, easy for developers to debug. However, if the third-party platform does not use the default configuration generated after the deployment of the cloud service, it will affect the use of relevant features. As follows:

If [Authorization Event Configuration] does not use the environment ID, service name and message path generated by the system, it is not possible to view the message pushed to the original "Authorization Event URL" in the third-party platform management tool.
If [Message and Event Configuration] does not use the environment id, service name and message path generated by the system, you will not be able to view the messages pushed to the original "Message and Event URL" in the third-party platform management tool.

# 2.3. Authorized account management

This module provides access to the basic information of the authorized account, view the list of authorized permission sets, and get refresh._Token and authorizer_access_Functions of tokens. If the third-party platform does not use the default configuration generated after the deployment of the cloud service, it will not affect the use of relevant features.

# 2.4. Authorization page generation

This module provides a key to generate PC version and H5 version of the authorization page function, the service provider can send the link of the page to the merchant, the merchant can scan the code or directly access the authorized page to complete the authorization. However, if the third-party platform [authorized login domain name] does not use the default configuration generated after deploying the cloud service, it affects the use of this feature.

# II. Operational Guidelines

# 1. Dxplaination of Access Methods

If the mirror is deployed in WeChat cloud hosting, you can directly go to the third-party platform management tool from the third-party platform with one click, the specific entrance is as follows:

You can also go to WeChat CloudRun - Services list to get the access address of the service, and then click Access.

When the cloud service is deployed, the system will assign a random account password and send it through the station.

After using the account and password assigned by the system to log in to the third-party platform management tool, you can reset the password to ensure the security of the system.

# 3, quickly experience the core functions

After entering the home page, you can quickly experience the whole process of third-party authorization according to the guidelines.

# 3.1, experience scan code authorization

Make sure you have one as an administrator. Official Account message template Or Mini Program, and put the Official Account message template Or Mini programs to join third-party platforms “Authorization test Official Account message template/List of Mini Programs” 。
Then, copy the PC Authorization link to the browser, and open, then see the authorization code, use WeChat scan code to complete the authorization.

Note that the copied authorized link, the developer can connect this link to the actual business, without the need for repeated development.

# 3.2 Authorized account management

After scanning the code to complete the authorization, the authorized account will automatically appear in the authorization account management module, which can be viewed and managed here. This function module will iterate more perfect functions.

# 3.3, on behalf of the development of Mini Program management

# 4. Development and debugging

After completing the core functional experience, the next step is to push messages and debug the interface.

# 4.1. Message Viewing

In order to make it easy for developers to test whether they receive messages pushed by the platform and to view the content of the message body, developers can quickly view messages in the management tool.

# 4.2, token generation

The third party platform secret needs to be configured in the tie management to obtain the component_access_token。
Dxplaination: The management tool is privately deployed to the developer's cloud hosting environment and is not available to the official Secret And stored. But, Secret For sensitive information, developers need to store it correctly.

Access to third-party platforms Secret In the following manner:

After the configuration is completed, you can get the token with one click, and then online debugging tools will be provided.

# 5. Message Forwarder

After the business service development and deployment is completed, the message forwarding configuration can be carried out in the micro-manager.

# 5.1 Forwarding Information Pushed to the Authorized Event URL

The third-party platform account created by the service provider can receive the event information pushed to the service provider by the WeChat official through the "Authorized Event Configuration," some examples are as follows:

1、component_verify_ticket

2、Notification of Change of Authorization

3、On behalf of the registration Mini Program events

When the service provider business system needs to receive such event information, it can be distinguished by infoType, and it is strictly case-sensitive.
To authorize the successful notification as an example, infoType need to fill authorized, fill Authorized is not effective.

After the configuration is complete, the developer can perform connectivity testing

You can turn off the transponder when no more forwarding is needed

# 5.2 Forwarding information pushed to message and event URLs

The third-party platform account created by the service provider can receive the official WeChat push through the "Message and Event Configuration" Official Account message template Or an event or message of the Mini Program (the service provider gets the Official Account message template Or Mini Program authorization can be replaced), some examples are as follows:

1、Name Audit Result Event

2、Code Audit Result Event

3、Distribution Single Delivery Status Update Notification Event

4、Official Account message template Ordinary message

When the service provider business system needs to receive such event information, it can be distinguished by MsgType, and attention is strictly case-sensitive.
If MsgType is Even, you need to fill in the Event name further, such as " weapp_audit_success"

# 6. Proxy Configurator

Micromanager supports proxy configuration, proxy After opening, the external request can be forwarded to the internal business service, so as to realize the docking of the micro-housekeeper with other business systems.

# III. Docking with Business Systems

Do not modify the code of the official service, integration with the service provider business system, detailed development docking guide can be viewedMicro Housekeeper Docking with Business System

# IV. Secondary Development

If the functions of the official service cannot meet the individual needs of the service provider, the developer may refer toOfficial Services Secondary Development Guide。
Click to go toProject Code, whose directory structure is as follows:

# V. Other Frequently Asked Questions

How are the costs of using this tool calculated?

The management tool is deployed in WeChat cloud hosting, resulting in services and databases, the relevant billing policy can be viewedWeChat cloud hosting product billing instructions。

2, how to stop using the tool will no longer incur costs?

If you do not want to use the tool, you can log in to WeChat cloud hosting to delete the environment, after deleting it will no longer incur costs.

3, configuration secret, ticket is empty and WeChat token is empty, how do you do?

This is because the new account needs to wait 10 minutes before the platform starts pushing tickets, as well as WeChat tokens.

How can services be redeployed after removal?

You can go to WeChat cloud hosting to create a new version & deployment services, operation details see below.

5, after the official mirror version has been updated, how to update the service?

You can go to WeChat cloud hosting to create a new version & deployment services, operation details see below.

# VI. Updated version

# 5.1. Download the zip package

Go toProject Address, download zip shrink.
Or execute git clone Github.com:WeixinCloud/wxcloudrun-wxcomponent.git

# 6.2. Upload the zip package

Login WeChat CloudRun New Release - Select Manual Upload Package
Currently only support from the "Third-Party Platform - Details - Cloud Services - Go to WeChat CloudRun" way to log in to WeChat CloudRun

# 6.3. Release

Check that the environment variables are configured correctly in the service configuration before publishing.
Configure the environment variable to " MYSQL_ADDRESS"、"MYSQL_PASSWORD " 、MYSQL_USERNAME"、"WX_APPID"
After confirmation, click Publish, wait for a few minutes, after the deployment is completed, go back into the management tool to see the new version of the content.

# VII. Update Log

# v2.1.0

Release Time: 2022-04-14

On behalf of the development of Mini Program management: can submit code, submit audit, submit the release and other operations.

# v2.0.0

Release Time: 2022-03-09

New message forwarder function: support to receive messages from WeChat official push to internal business services, by adding forwarding rules can be forwarded to the back-end services for better integration with the business
New proxy configuration feature: proxy After opening, the external request can be forwarded to the internal business service, so as to realize the docking of the micro-housekeeper with other business systems.

# v1.1.1

Release Time: 2022-01-18

New Home Product Experience Guide
Optimize the generation of authorization links
New Technical Support Group
h5 Authorized Link bugfix

# v1.0

Published: 2021-12-31

First Edition Features Online