workweixin

엔터프라이즈 WeChat Go SDK

공식 인터페이스 문서->

Go 언어는 Go용 합리적인 Work Weixin SDK인 엔터프라이즈 WeChat SDK를 구현합니다.

SDK는 타사 서비스 제공업체의 관점에서 구성됩니다. 타사 애플리케이션 SDK와 자체 개발된 SDK를 통합합니다. 새로운 SDK 코드의 원클릭 생성을 지원합니다. 사용이 간편하고 확장이 유연합니다. .

• API 및 콜백 이벤트를 포함한 원클릭 SDK 코드 생성 지원
• 캐싱 솔루션을 사용하여 분산형 access_token/jsapi_ticket을 구현하면 여러 서비스 중 단 하나의 서비스만 Qiwei API를 호출하여 access_token/jsapi_ticket을 요청할 수 있도록 하여 API 호출 횟수를 줄이고 다시 시작한 후 서비스를 다시 획득해야 하는 필요성을 줄입니다.
  • 캐시 솔루션은 맞춤형 스토리지와 기본 메모리 스토리지를 지원합니다.
  • 기본 캐시는 2시간이며, 기업이 인증을 취소하면 캐시 정리가 사전에 실행됩니다.
• 여러 서비스가 최신 suite_ticket을 읽을 수 있도록 캐싱 솔루션을 사용하여 suite_ticket 읽기/업데이트(suite_ticket은 10분마다 업데이트됨)
  • 캐시 솔루션은 맞춤형 스토리지와 기본 메모리 스토리지를 지원합니다.
• 맞춤형 로그 저장을 지원하고 Logger 인터페이스 제공: 로그 수집을 용이하게 하기 위해 자체적으로 로거를 구현하는 데 사용됩니다.
  • 기본 log.Printf 출력
• 승인된 엔터프라이즈 ApiClient를 얻을 때 데이터베이스 등에서 엔터프라이즈 데이터를 읽을 수 있도록 사용자 정의 클로저가 지원됩니다. 예: Sdk.GetThirdAuthCorpApiClient

Enterprise WeChat 타사 애플리케이션 개발 블로그 게시물을 보려면 클릭하세요.

설치 명령

go get github.com/zsmhub/workweixin

SDK 코드를 생성하는 원클릭 명령(需手动格式化代码；企微页面调整后一键生成代码可能失效)

• Qiwei 콜백 이벤트 코드 생성

  make callback doc=企微文档链接 [prefix =生成文件名前缀]
  
  # example
  make callback doc=https://developer.work.weixin.qq.com/document/path/92277 prefix=客户联系

  팁: callbacks/callback_constant.go에 이 콜백 이벤트에 대한 상수 정의가 없으면 수동으로 채워야 합니다.

• Qiwei API 코드 생성

  make api doc=企微文档链接 [prefix =生成文件名前缀]
  
  # example
  make api doc=https://developer.work.weixin.qq.com/document/path/90600 prefix=应用授权

  팁:

  1. GET 인터페이스를 생성합니다. 요청 매개변수의 데이터 유형을 수동으로 조정해야 합니다.
  2. 일부 인터페이스 문서의 요청/응답 json 예 일부 필드가 누락된 경우 수동으로 입력해야 합니다.
  3. 일부 복잡한 페이지에는 메시지 푸시 > 애플리케이션 메시지 보내기 인터페이스와 같은 SDK의 수동 구성이 필요합니다.

SDK 호출 예시

전체 예제를 보려면 ./demo 폴더로 이동하는 것이 좋습니다!

전체 데모를 보려면 클릭하세요.

Qiwei 콜백 이벤트 SDK 호출 예

 // 企微回调设置初始化
func InitCallbackHandler () error {
    // 服务商回调解析
    if err := workweixin . Sdk . NewProviderCallbackHandler ( config . CorpCallbackToken , config . CorpCallbackEncodingAESKey ); err != nil {
        return err
    }

    // 第三方应用回调解析【可选】
    if err := workweixin . Sdk . NewThirdAppCallbackHandler ( config . AppSuiteCallbackToken , config . AppSuiteCallbackEncodingAESKey ); err != nil {
        return err
    }

    // 第三方小程序回调解析【可选】
    if err := workweixin . Sdk . NewMiniSuiteCaNewThirdMiniCallbackHandlerllbackHandler ( config . MiniSuiteCallbackToken , config . MiniSuiteCallbackEncodingAESKey ); err != nil {
        return err
    }

    // 自建应用代开发回调解析【可选】
    if err := workweixin . Sdk . NewCustomizedTemplateCallbackHandler ( config . CustomizedCallbackToken , config . CustomizedCallbackEncodingAESKey ); err != nil {
        return err
    }

    return nil
}

// 服务商-解析并获取回调信息
workweixin . Sdk . ProviderCallback . GetCallBackMsg ( r * http . Request )

// 第三方应用-解析并获取回调信息
workweixin . Sdk . ThirdAppCallback . GetCallBackMsg ( r * http . Request )

// 第三方小程序-解析并获取回调信息
workweixin . Sdk . ThirdMiniCallback . GetCallBackMsg ( r * http . Request )

// 自建应用代开发--解析并获取回调信息
workweixin . Sdk . CustomizedTemplateCallback . GetCallBackMsg ( r * http . Request )

// 第三方应用回调完整示例
func HandleAppPostRequest ( c echo. Context ) error {
    msg , err := workweixin . Sdk . ThirdAppCallback . GetCallBackMsg ( c . Request ())
    if err != nil {
        return err
    }

    switch msg . MsgType {
    case callbacks . MessageTypeThird : // 第三方应用回调
        switch msg . EventType {
            // 推送suite_ticket，每十分钟推送一次suite_ticket
            case callbacks . InfoTypeSuiteTicket :
                extras , ok := msg . Extras .(callbacks. ThirdSuiteTicket )
                if ! ok {
                    return errors . New ( "suite_ticket get failed" )
                }

                ticket := extras . SuiteTicket . Text
                workweixin . Sdk . ThirdAppClient . RefreshSuiteTicket ( ticket , time . Hour )

                // todo: 此处可将 suite_ticket 保存进数据库

            // 企业取消授权通知
            case callbacks . InfoTypeCancelAuth :
                  workweixin . Sdk . RemoveThirdAuthCorp ( corpId )
        }
    }

    return nil
}

Qiwei api sdk 호출 예시

 import "xxx/workweixin/demo"

// 企微API客户端初始化
func InitApiHandler () error {
    // 初始化企微sdk参数
    workweixin . Sdk . InitOptions (apis. Options {
        DcsToken :                     demo. DcsTokenByRedis {},
        DcsAppSuiteTicket :            demo. DcsAppSuiteTicketByRedis {},
        GetThirdAppAuthCorpFunc :      demo . GetThirdAppAuthCorpToSdk ,
        GetCustomizedAppAuthCorpFunc : demo . GetCustomizedAppAuthCorpToSdk ,
        Logger :                       demo. Logger {},
    })

    // 服务商API客户端初始化
    workweixin . Sdk . NewProviderApiClient ( config . CorpId , config . CorpProviderSecret )

    // 第三方应用API客户端初始化【可选】
    suiteTicket := dao . ConfigDao . GetByUniqueIndex ( global . ConfigKeySuiteTicket )
    workweixin . Sdk . NewThirdAppApiClient ( config . CorpId , config . AppSuiteId , config . AppSuiteSecret , suiteTicket . V )

    // 自建应用代开发API客户端初始化【可选】
    customizedTicket := dao . ConfigDao . GetByUniqueIndex ( global . ConfigKeyCustomizedTicket )
    workweixin . Sdk . NewCustomizedApiClient ( config . CorpId , config . CustomizedAppSuiteId , config . CustomizedAppSuiteSecret , customizedTicket . V )

    // 由于本地开发环境和预发布无法接收企微回调事件，故需定时刷新suite_ticket
    if config . IsLocal () || config . IsUat () {
        go func ( suiteTicket , customizedTicket model. Config ) {
            defer recover ()
            ticker := time . NewTicker ( 10 * time . Minute )
            defer ticker . Stop ()
            for {
                // 更新第三方应用ticket
                _ = suiteTicket . DelCache () // 清除本地缓存
                suiteTicket = dao . ConfigDao . GetByUniqueIndex ( global . ConfigKeySuiteTicket )
                workweixin . Sdk . ThirdAppClient . RefreshSuiteTicket ( suiteTicket . V , 30 * time . Minute )

                // 更新自建应用代开发ticket
                _ = customizedTicket . DelCache () // 清除本地缓存
                customizedTicket = dao . ConfigDao . GetByUniqueIndex ( global . ConfigKeyCustomizedTicket )
                workweixin . Sdk . CustomizedAppClient . RefreshSuiteTicket ( customizedTicket . V , 30 * time . Minute )

                <- ticker . C
            }
        }( suiteTicket , customizedTicket )
    }

    return nil
}

// 服务商级别API调用接口示例：获取接口调用许可订单详情
orderDetail , err := workweixin . Sdk . ProviderClient . ExecGetOrderLicense (apis. ReqGetOrderLicense { OrderID : orderId })

// 应用级别API调用接口示例：获取企业永久授权码
resp , err := workweixin . Sdk . ThirdAppClient . ExecGetPermanentCodeService (apis. ReqGetPermanentCodeService { AuthCode : authCode })

// 授权企业级别API调用接口示例：获取部门列表
apiClient , err := workweixin . Sdk . GetThirdAuthCorpApiClient ( v . CorpId )
if err != nil {
    fmt . Println ( err )
}
department , err := apiClient . ExecListDepartment (apis. ReqListDepartment {})

// 获取provider_access_token
accessToken , err := workweixin . Sdk . ProviderClient . GetToken ()

// 获取suite_access_token
accessToken , err := workweixin . Sdk . ThirdAppClient . GetToken ()

// 获取授权企业access_token
accessToken , err := apiClient . GetToken ()

// 构造oauth2链接
oauthUrl := workweixin . Sdk . ThirdAppClient . GetThirdOauthUrl (apis. GetThirdOauthUrlReq {
    RedirectUri : "xxx" ,
    Scope :       "xx" ,
    State :       "xx" ,
})

// 企微 error code 类型强制转换
if err != nil {
    if apiError , ok := err .( * apis. ClientError ); ok && apiError . Code == apis . ErrCode60011 {
        return errors . New ( "无权限访问" )
    }
    return nil , err
}

// 推送消息到第三方应用
reqSentMessageCard := apis. ReqSentMessageCard {
    ToUser :  v . InstallUserId ,
    MsgType : "news" ,
    AgentId : v . AgentId ,
    News : apis. ReqSentMessageCardNewsBody {
        Articles : []apis. ReqSentMessageCardNewsArticleBody {
            {
                Title :       "新模块【xxx】已上线" ,
                Description : "快进入【管理后台】把它配置到你的【侧边栏】中！" ,
                Url :         "https://xxx" ,
                UrlImg :      "https://xxx/workbench-config.jpg" ,
            },
        },
    },
}
if _ , err = apiClient . ExecSentMessageCard ( reqSentMessageCard ); err != nil {
    fmt . Println ( err )
}

// 帮前端获取 wx.config/wx.agentConfig 的签名配置
// 步骤1：获取授权企业的jsapi_ticket，wx.config注入的是企业的身份与权限，而wx.agentConfig注入的是应用的身份与权限
// 步骤2：JS-SDK使用权限签名算法
type QyapiGetJssdkConfigResp struct {
    CorpJsapiTicket apis. GetJsSdkSignResp `json:"corp_jsapi_ticket"`
    AppJsapiTicket  apis. GetJsSdkSignResp `json:"app_jsapi_ticket"`
}
func ( qyapiRepo ) GetJssdkConfig ( req form. QyapiGetJssdkConfigReq ) ( * QyapiGetJssdkConfigResp , error ) {
    apiClient , err := workweixin . Sdk . GetThirdAuthCorpApiClient ( req . CorpId )
    if err != nil {
        return nil , err
    }

    corpTicket , err := apiClient . GetJSAPITicket ()
    if err != nil {
        return nil , err
    }

    appTicket , err := apiClient . GetJSAPITicketAgentConfig ()
    if err != nil {
        return nil , err
    }

    agentId := apiClient . AgentId
    return & QyapiGetJssdkConfigResp {
        CorpJsapiTicket : apiClient . GetJsSdkSign ( req . CorpId , req . Url , corpTicket , 0 ),
        AppJsapiTicket :  apiClient . GetJsSdkSign ( req . CorpId , req . Url , appTicket , agentId ),
    }, nil
}

디렉토리 구조

 .
├── api_generate             一键生成企微API代码
├── apis                     企业微信API整合
│   └── api.error.go         全局错误码
├── callback_generate        一键生成企微回调事件代码
├── callbacks                企业微信回调事件整合
│   └── callback_constant.go 回调事件常量定义
├── demo                     sdk调用示例
├── docs                     企业微信相关文档
├── internal                 消息加解密库
└── main.go                  入口文件

메모

• SDK에 특정 콜백 이벤트나 특정 API가 없는 경우 원클릭 SDK 코드 생성 명령을 사용하여 생성한 후 PR을 제출할 수 있습니다.

추천 오픈소스 프로젝트

• 기업 위챗 GO SDK
• Doudian 오픈 플랫폼 GO SDK
• 위챗 비디오 계정 GO SDK
• Xiaohongshu 오픈 플랫폼 GO SDK

오픈소스 프로젝트 참조

• 오픈SCRM

지원하다