> For the complete documentation index, see [llms.txt](https://docs.zongsoft.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.zongsoft.com/documentation/en/framework/externals/projects/wechat.md).

# Wechat (wechat)

Wechat project's capability scope, deployment products, integration entrance and usage boundaries.

Provide WeChat accounts, public platforms, third-party platforms and payment adaptation. Application identity, user identity, platform authorization and merchant permissions need to be handled separately.

| Item                  | value                                                                          |
| --------------------- | ------------------------------------------------------------------------------ |
| source code directory | `externals/wechat`                                                             |
| main bag              | `Zongsoft.Externals.Wechat`                                                    |
| Companion theme       | [Cloud Services and Callbacks](/documentation/en/framework/externals/cloud.md) |

## Deployment and Usage Portal

Append the main package to the existing host's [Deployment checklist](/documentation/en/references/deploy-files.md), and retain the plugin list, assembly and ancillary running resources in the package:

{% code title="Application.deploy (append fragment)" %}

```ini
[plugins zongsoft externals wechat]
nuget:Zongsoft.Externals.Wechat
```

{% endcode %}

Configure accounts, certificates and services according to the package options. The main package provides client capabilities, and the HTTP API and callback entry are independent products.

Related products include `Zongsoft.Externals.Wechat.Web` and `Zongsoft.Externals.Wechat.Gateway`, which can be combined according to actual needs.

## Integration Steps

1. First determine the WeChat product used and the identity of the corresponding application or merchant.
2. Check the authorization, token saving and refresh processes, and then verify the required client operations.
3. Register the handler when receiving the callback to verify the signature, decryption, duplicate notification and response content required by the target protocol.

For specific configuration, calling examples and related basic concepts, see [Cloud Services and Callbacks](/documentation/en/framework/externals/cloud.md).

## Project Boundaries

{% hint style="info" %}
💡 Default Gateway's POST dispatch is not equal to complete platform address verification or automatic signature verification. Source verification and idempotent check should be completed before business execution, and the gateway routing name cannot be used as the basis for authentication.
{% endhint %}

## Further Reading

[Browse extensions by project](/documentation/en/framework/externals/projects.md) · [Cloud Services and Callbacks](/documentation/en/framework/externals/cloud.md) · [source code and project description](https://github.com/Zongsoft/framework/tree/main/externals/wechat)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.zongsoft.com/documentation/en/framework/externals/projects/wechat.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.