Hướng dẫn cấu hình api tích hợp GoEDU với phần mềm bên thứ 3

Dưới đây là hướng dẫn nhanh cách bật api + webhook giúp tích hợp dữ liệu giữa phần mềm GoUP và phần mềm bên thứ 3
- API: cho phép đẩy dữ liệu từ cty phần mềm khác về phần mềm GoUP, cho phép lấy dữ liệu, thêm bản ghi và xóa
- Webhook: cho phép gửi dữ liệu khi nhập từ form: thêm sửa, xóa về phần mềm của bên thứ 3 để đồng bộ 2 hệ thống.
I. Để tích hợp với phần mềm bên thứ 3 bận cần bật api theo cá bước
B1. Vào Hệ thống, chọn mục Cấu hình chung
B2 Chọn mục khách hàng
B3 Tích bật api và gửi cho bên phần mềm thứ 2 đường dẫn api để tích hợp có dạng
http://{{code}}.goup.vn/api/edu/v4
Trong đó {{code}}: là mã GoUP cung cấp

B4. Chọn Bật webhook để bật webhook gửi dữ liệu về bên thứ 3
B5. Nhập địa chỉ webhook bên thứ 3(Bạn cần yêu cầu bên phần mềm thứ 3 cung cấp địa chỉ này.

II. API hướng dẫn tích hợp

Tải bản hướng dẫ tích hợp api GoUP tại đây

GoUP API

1. Endpoint

Đường dẫn api có dạng http://{{code}}.goup.vn/api/{{app}}/v/4.0/

Trong đó:

• Code: Mỗi khách hàng sẽ được cấp 01 mã code này để truy cập phần mềm
• App: Tên phần mềm sử dụng, tùy vào khách hàng ký hợp đồng gói nào

2. HTTP Methods

Tất cả truy vấn đều gửi về theo giao thức HTTP POST và chuẩn UTF-8 encoding, URL-encoded parameter.

 "Content-Type"  "application/json"

3. Security

Để đảm bảo bảo mật, tất cả truy vấn cần gửi kèm theo seckey GoUP cung cấp. Sec key này có thể cấu hình được trên phần mềm.

Tất cả dữ liệu trả về có dạng json

• Thành công: {msg=ok,data=??}
• Không thành công: {msg=”Error msg”}

4. API submit dữ liệu từ phần mềm bên thứ 3 về phần mềm GoUP

Các truy vẫn có dạng:

Dữ liệu gửi lên:

{

            "type":" search",

            “seckey:”goup-102988”,

            "data": {pagesize:10,currentpage:1}

}

Dữ liệu trả về:

{

            "msg":"ok",

            "data":[{}]

}

Khách hàng:

Đường dẫn: http://{{code}}.goup.vn/api/{{app}}/v/4.0/customers

No	Type	Data	Required	Description
	search	magesize, currentpage,	magesize, curentpage	Lấy ds khách hàng
	get	makh	makh	Lấy chi tiết 1 khách hàng
	delete	makh	makh	Xóa khách hàng
	save	isadd, id, makh, tenviettat, tenkh, dienthoai, didong, email, diachi, skype, facebook, website, ghichu, manv	isadd, makh, tenviettat, tenkh, manv	Lưu thông tin khách hàng. Nếu isadd=true=> Thêm mới, isadd<>true hệ thống cập nhập dữ liệu theo id Manv: tương ứng mã số nhân viên trong phần mềm GoUP

5. Webhook: (gửi dữ liệu sang phần mềm bên thứ 3)

• Chức năng chỉ thực hiện khi thêm, sửa, xóa khách hàng trên form của phần mềm
• Để thực hiện được chức năng cần sử dụng gói phần mềm có tính năng webhook.
• Khách hàng cần y/c bên thứ 3 cung cấp đường dẫn api vào hứng dữ liệu webhook theo chuẩn do GoUP cung cấp

Dữ liệu gửi lên webhook theo giao thức HTTP POST và chuẩn UTF-8 encoding, URL-encoded parameter.

 “Content-Type”  “application/json”

Cấu trúc gửi dữ liệu khi xóa khách hàng có dạng:

{

“object”:”customer”,

“type”:”delete”,

“data”:”10011,10012”

}

Nếu người dùng chọn xóa nhiều trên phần mềm sẽ trigger nhiều mã kh phân cách bằng dầu “,”

Cấu trúc gửi dữ liệu khi thêm, sửa khách hàng có dạng:

{

“object”:”customer”,

“type”:”save”,

“data”:{isadd:true,makh:”kh10010”,tenkh:”kh 10010”,email:””

}

Data thông tin khách hàng gồm các trường: makh,tenkh,email,dienthoai,didong, skype, facebook, website, diachi, ghichu

Trường	Kiểu dữ liệu	Mô tả
makh	String(50)	Mã khách hàng, không được trùng.
Tenviettat	String(50)	Là mã nhập tay trên phần mềm
Tenkh	String(350)
Dienthoai	String(200)
Didong	String(200)
Email	String(350)
Skype	String(350)
Facebook	String(350)
Website	String(350)
Diachi	String(350)
Ghichu	String(500)