快速入门

添加依赖

开发版

  1. $ git clone https://gitee.com/javen205/TNWX.git
  2. $ cd TNWX
  3. $ yarn bootstrap
  4. $ yarn tsc

稳定版

二者任选其一

  1. $ npm i tnwx
  2. $ yarn add tnwx

导入相关模块

  1. import {
  2. WeChat,
  3. ApiConfigKit,
  4. QyApiConfigKit,
  5. AccessToken,
  6. QyAccessTokenApi,
  7. Kits,
  8. HttpKit,
  9. ApiConfig,
  10. ...
  11. } from 'tnwx';

初始化

提示

调用任何接口之前都必须做应用的初始化

  1. new ApiConfig(appId?: string, appScrect?: string, token?: string, encryptMessage: boolean = false, encodingAesKey?: string, corpId?: string, suiteTicket?: string);

ApiConfig 参数说明

第一个参数:appId。 企业微信时 appId 对应的值为 agentId

第二个参数:appScrect

第三个参数:令牌 Token 可以任意填写

第四个参数:是否开启加密 encryptMessage 默认值为 false。测试号必须为 false, 企业微信必须为 true

第五个参数:消息加解密密钥 encodingAesKey 非必须。 encryptMessage 为 true 时必须

第六个参数:企业ID 非必须。 企业微信时必须

第七个参数:企业微信开放平台应用的 Ticket 非必须。

初始化示例

  1. let devApiConfig = new ApiConfig('wx614c453e0d1dcd12', '19a02e4927d346484fc70327970457f9','Javen');
  2. // 微信公众号、微信小程序、微信小游戏 支持多应用
  3. ApiConfigKit.putApiConfig(apiConfig);
  4. // 开启开发模式,方便调试
  5. ApiConfigKit.devMode = true;
  6. // 设置当前应用
  7. ApiConfigKit.setCurrentAppId(devApiConfig.getAppId);
  8. // 企业微信 支持多企业微信多应用
  9. let qyApiConfig = new ApiConfig('1000004', 'fs-wmeFEr4PCMY7WGYyv1rDKGwaPLTvWFFX3UL396QI','Javen',true,'GFLxP8ppqcgQbI0yivtMkY4pkOAOiapHhQsCOgYUnYK','wxdbc631b5210be89f');
  10. QyApiConfigKit.putApiConfig(qyMiniApiConfig);
  11. // 开启开发模式,方便调试
  12. QyApiConfigKit.devMode = true;
  13. // 设置当前应用
  14. QyApiConfigKit.setCurrentAppId(qyApiConfig.getAppId, qyApiConfig.getCorpId);
  15. // 默认配置
  16. // HttpKit.setHttpDelegate = new AxiosHttpKit();
  17. // ApiConfigKit.setCache = new DefaultCache();

更多

开启开发者模式

获取 AccessToken