api server

Wichtig: Für dieses Projekt fehlt die Wartung und es besteht derzeit nicht die Möglichkeit, die Wartung fortzusetzen. Wenn Sie daran interessiert sind, es zu warten, können Sie mich kontaktieren und ich werde mein Bestes geben, um Ihnen zu helfen.

Sicheres, leistungsstarkes und einfach zu entwickelndes WeChat SCRM für Unternehmen

Dokumentation |. Screenshots |

Projekteinführung

OpenSCRM ist ein hochwertiges WeChat-Verkehrsverwaltungssystem für private Domänen für Unternehmen, das auf Go und React basiert

Schnellstart, Demoprojekt starten (Docker-Compose)

Wir verlassen uns auf Docker-Compose, um MySQL und Redis zu starten. Die API-Server-Back-End-API wird lokal kompiliert und gestartet, und die Dashboard-Front-End-Schnittstelle wird ebenfalls lokal kompiliert und gestartet.

Starten Sie MySQL und Redis

Docker-Komponieren

Starten Sie den API-Server

• conf/config.example.yaml -> conf/config.yaml // Ändern Sie einfach das SuperAdmin-Feld und ändern Sie die anderen nach der Ausführung
• Starten Sie main.go im Stammverzeichnis des Projekts und führen Sie es aus
• API-Abhöradresse http://localhost:9001/

Starten Sie das Front-End-Dashboard

• Git-Klon https://github.com/openscrm/dashboard
• Installieren Sie die Version 16.20.2 von nodejs. Bei anderen Versionen treten Kompatibilitätsprobleme auf. Es wird empfohlen, nvm zur Verwaltung der Knotenversion zu verwenden.
• Optional können Sie die inländische NPM-Paketspiegelquelle installieren, siehe https://npmmirror.com/
• npm install --legacy-peer-deps
• NPM-Laufstart

Besuchen Sie die Website

http://localhost:9000/

---

Richten Sie eine Back-End-Entwicklungsumgebung ein (optional)

Installieren Sie die Go-Sprachumgebung

https://go.dev/doc/install

Konfigurationsdatei ändern

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

Starten Sie das Programm

 go run main.go

Besuchen Sie die Website

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

Erstellen Sie eine Front-End-Entwicklungsumgebung

Weitere Informationen finden Sie unter: https://github.com/openscrm/dashboard

Teilprojekt

Session Archive Service Management Panel Enterprise WeChat H5 Seitenleiste

Projektfunktionen

• Hohe Sicherheit : Enterprise WeChat kontrolliert die sensiblen Daten aller Mitarbeiter und Kunden des Unternehmens, wie Telefonnummern, Positionen, Kunden-Tags, Kontaktinformationen usw. Wenn sie durchsickern, wäre der Schlag für das Unternehmen fatal. Unser Team verfügt über umfangreiche Erfahrung im Web-Sicherheitsbereich, um die Projektsicherheit zu gewährleisten.

• Hohe Leistung und hohe Stabilität : Dank der hervorragenden technischen Fähigkeiten von Go und der einfachen und effektiven Funktionen zur Parallelitätskontrolle verfügt OpenSCRM über eine hohe Leistung und Stabilität, die mit der von führenden SaaS-Anbietern vergleichbar ist.

• Priorisieren Sie die Lesbarkeit des Codes : Der Abschluss der Projektentwicklung ist nur der Anfang des Projekts. Nur lesbarer Code kann die hohe Qualität und Effizienz späterer Iterationen gewährleisten ist auch das Designziel der Go-Sprache. Wir haben sehr vollständige Codekommentare und alle Codes sind bestrebt, klar und leicht lesbar zu sein.

• Einfach zu entwickeln : Da es sich um ein Open-Source-Projekt handelt, haben wir viel daran gearbeitet, das Projekt einfach und benutzerfreundlich zu gestalten, damit mehr Menschen von diesem Projekt profitieren können. Wir machen nur notwendige Abstraktionen (MVC) und vermeiden die Einführung neuer Konzepte. Wir bestehen darauf, so wenig Middleware-Abhängigkeiten wie möglich zu haben und verlassen uns nur auf MySQL und Redis. Beispielsweise implementieren wir eine Verzögerungswarteschlange auf Basis von Redis, ohne Kafka einzuführen ES.

Python-, PHP- und NodeJS-Entwickler können dieses Projekt bedenkenlos verwenden. Es wurde viel Arbeit in dieses Projekt gesteckt, um den Einstieg zu vereinfachen.

Projekt-Screenshots

Technologie-Stack

Backend-Technologie-Stack

• Gehen
• Gin
• GORM
• Redis
• MySQL >= 5.7

Front-End-Technologie-Stack

• Reagieren
• Typoskript
• Ameisen-Design
• Ant Design Pro
• Pro-Komponenten

Verzeichnisstruktur

 ├─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 测试代码

Installationsanleitung

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

API-Debugging

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

Copyright-Erklärung

OpenSCRM folgt dem Apache2.0-Protokoll und ist für die kommerzielle Nutzung kostenlos

FAQ

1. Die Initialisierung ist fehlgeschlagen und der Fehler „Zugriff über Ihre IP nicht zulassen“ ist aufgetreten.

Fehlerbeispiel:

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

Lösung

Melden Sie sich beim Enterprise WeChat-Administrator-Backend an -> Sicherheit und Verwaltung -> Verwaltungstools -> Kontaktbuchsynchronisierung -> Enterprise Trusted IP. Fügen Sie eine öffentliche IP hinzu, die den Zugriff auf die Enterprise WeChat-Schnittstelle ermöglicht

---

2. Eingabeaufforderung der Anmeldeschnittstelle: „redirect_uri“ stimmt nicht mit dem konfigurierten Rückrufdomänennamen für den Autorisierungsabschluss überein

Fehlergrund

Bei der Enterprise-WeChat-Scan-Anmeldung muss der Domänenname der autorisierten Anmeldeadresse konfiguriert werden. Wenn der Domänenname inkonsistent ist, wird dieser Fehler angezeigt. Sie müssen Ihre eigene Anwendung erstellen, um die entsprechende Konfiguration abzuschließen.

Lösung 1 (für Produktionsumgebung)

Melden Sie sich beim Enterprise WeChat-Administrator-Backend an -> Anwendungsverwaltung -> Anwendung -> Selbst erstellte Anwendung (Ihre Anwendung) -> Autorisierte Enterprise WeChat-Anmeldung -> Autorisierte Rückrufdomäne

Workaround 2 (für Entwicklungsumgebung)

Bei der lokalen Entwicklung ist es unpraktisch, Anmelderückrufe zu konfigurieren. Es kann eine erzwungene Anmeldung verwendet werden. Fügen Sie den Parameter ?debug=1 zur URL der Anmeldeschnittstelle hinzu. Stellen Sie außerdem sicher, dass Env in conf/config.yaml als DEV oder TEST konfiguriert ist

3. Das Front-End kann keine Verbindung zum Back-End-API-Server herstellen.

Überprüfen Sie die Nginx-Konfiguration docker/nginx/conf/conf.d/dashboard.conf

---

4. Wie stellt das im Container laufende Programm eine Verbindung zum Host her?

Die Host-IP-Adresse in Docker ist 172.17.0.1. Alle Docker-Dienste sind die Standard-Überwachungsports für den Host. Geben Sie in der Konfigurationsdatei 172.17.0.1 ein.

---