api server

重要：本專案缺乏維護，目前沒有力量繼續維護，如果有興趣維護的朋友，可以聯絡我，我會盡力提供協助。

安全，強大，易於開發的企業微信SCRM

文件| 截圖| 演示| 安裝

專案簡介

OpenSCRM是一套基於Go和React的高品質企業微信私人域流量管理系統

快速開始，啟動示範專案（docker-compose）

我們依靠docker-compose啟動mysql和redis。 api-server後端API本地編譯啟動， dashboard前端介面同樣本地編譯啟動

啟動mysql和redis

docker-compose up

啟動api-server

• conf/config.example.yaml -> conf/config.yaml // 修改SuperAdmin欄位就行了，其他的跑起來再改
• 專案根目錄下啟動go run main.go
• api監聽網址http://localhost:9001/

啟動前端dashboard

• git clone https://github.com/openscrm/dashboard
• 安裝16.20.2 版本的nodejs，只能是這個版本，其他版本會有相容問題，建議用nvm管理node版本
• 可選，安裝國內npm包鏡像來源，參考https://npmmirror.com/
• npm install --legacy-peer-deps
• npm run start

造訪站點

http://localhost:9000/

---

建置後端開發環境(可選)

安裝go語言環境

https://go.dev/doc/install

修改設定檔

conf/config.example.yaml -> conf/config.yaml

啟動程式

 go run main.go

造訪站點

http://dashboard.dev.openscrm.cn:9000/

建置前端開發環境

具體看：https://github.com/openscrm/dashboard

子專案

會話存檔服務管理面板企業微信H5側邊欄

專案特點

• 安全性高：企業微信控制了企業所有員工和客戶的敏感數據，如電話號碼，職位，客戶標籤，聯繫方式等，如果發生洩露， 對企業的打擊將是致命的。我們團隊有豐富的Web安全經驗保證專案安全性。

• 高效能，高穩定性：得益於Go出色的工程能力，簡單有效的並發控制能力，OpenSCRM具備比肩頭Saas廠商的高性能和高穩定

• 程式碼可讀性優先：我們深刻認同Google對於程式碼管理的看法，專案開發完成只是專案的開始，更多的工作在於維護和迭代， 唯有易讀的程式碼才能保證後期迭代的高質量，高效率，這也是Go語言的設計目標。我們有非常完善的程式碼註釋，所有程式碼力求清晰易讀。

• 易開發：作為開源項目，我們為了讓更多的人可以受益於此項目，我們做了大量工作力求項目簡單易上手。 我們只做必要抽象化（MVC），避免引入新慨念。我們堅持盡量少的中間件依賴，只依賴Mysql和Redis， 例如延遲隊列我們基於Redis實現， 沒有引入Kafka；例如全文檢索基於Mysql8全文檢索實現，沒有引入ES。

Python，PHP，NodeJS開發者放心使用本項目，本專案做了大量工作力求簡單，非常容易上手。

專案截圖

技術堆疊

後端技術堆疊

• Go
• Gin
• GORM
• Redis
• Mysql >= 5.7

前端技術堆疊

• React
• TypeScript
• Ant Design
• Ant Design Pro
• Pro Components

目錄結構

 ├─app
│  ├─callback 企业微信事件回调处理
│  │  ├─customer_event
│  │  ├─department_event
│  │  ├─group_chat_event
│  │  ├─msg_arch_event
│  │  ├─staff_event
│  │  └─tag_event
│  ├─constants 常量定义
│  ├─consumers 队列消费
│  ├─controller 控制器
│  ├─entities 消息实体，主要定义参数，请求，响应结构体
│  ├─middleware gin请求中间件
│  ├─models 数据库模型
│  ├─requests 请求定义
│  ├─responses 响应定义
│  ├─services 服务
│  ├─tasks 定时任务
├─bin 二进制文件
├─common 共同库
│  ├─app 基于Gin封装的常用请求响应处理函数
│  ├─delay_queue 基于Redis延迟队列
│  ├─ecode 错误码
│  ├─id_generator uuid生成
│  ├─log 日志
│  ├─redis redis操作库
│  ├─session session会话
│  ├─storage 存储
│  ├─util 常用工具函数
│  └─validator 请求验证
├─conf 配置文件
├─docker
│  ├─data
│  │  ├─dashboard
│  │  │  └─dist 管理后台构建的前端静态文件
│  │  ├─mysql
│  │  │  ├─conf mysql容器配置文件
│  │  │  └─db mysql容器数据文件
│  │  ├─nginx
│  │  │  ├─conf nginx容器配置文件
│  │  │  │  └─conf.d 
│  │  │  └─logs
│  │  ├─redis 
│  │  │  └─db redis容器数据文件
│  │  └─sidebar
│  │      └─dist 侧边栏构建的前端静态文件
│  └─lib 企业微信提供的会话存档动态链库
├─docs 文档
├─pkg 三方库
│  └─easywework 企业微信Api调用库
│      ├─errcodes 企业微信Api错误码
├─routers Gin路由
├─scripts 脚本
└─test 测试代码

安裝教學課程

https://github.com/openscrm/api-server/wiki/%E5%AE%89%E8%A3%85%E6%95%99%E7%A8%8B

Api調試

docs目录包含postman导出文件，可方便调试api

版權聲明

OpenSCRM遵循Apache2.0協議，可免費商用

FAQ

1.初始化失敗，出現not allow to access from your ip 錯誤

錯誤範例：

 get all departments from wx failedClientError { Code: 60020, Msg: "not allow to access from your ip, 错误

解決辦法

登入企業微信管理員後台->安全與管理->管理工具->通訊錄同步->企業可信任IP 新增允許存取企業微信介面的公網IP

---

2.登入介面提示：redirect_uri 與設定的授權完成回呼網域不一致

錯誤原因

企業微信掃描登入需要配置授權登入地址域名，如果域名不一致會提示此錯誤，演示站點用的我的配置，你需要自建應用完成相關配置

解決方法1（用於生產環境）

登入企業微信管理員後台->應用程式管理->應用程式->自建應用程式（你的應用程式）->企業微信授權登入->授權回調域

解決方法2（用於開發環境）

本地開發的時候，不方便設定登入回呼。可以使用強制登入。 登入介面url加上參數?debug=1。 同時確保conf/config.yaml中的Env配置為DEV或TEST

3.前端無法連線後端api-server.

檢查nginx配置docker/nginx/conf/conf.d/dashboard.conf

---

4.容器中執行的程式如何連結宿主機

docker中宿主機ip位址為172.17.0.1，所有docker服務預設監聽埠到宿主機上，設定檔中需要填入host的地方填172.17.0.1

---