Integration
Tài liệu tích hợp giữa các bên với phần mềm Gobysend
Để các phần mềm CRM của khách hàng và phần mềm Gobysend có thể dễ dàng tích hợp với nhau, CRM của khách hàng và Gobysend cần cung cấp các api theo mẫu.
Phần mềm Gobysend hỗ trợ đồng bộ dữ liệu về khách hàng và đơn hàng qua 2 phương pháp:
- API: hệ thống Gobysend sẽ chủ động gọi Api do đối tác cung cấp định kỳ 5p một lần để lấy các dữ liệu được thay đổi từ lần thời điểm lần cuối cùng đồng bộ.
- Webhook: Gobysend đăng ký đường dẫn webhook với hệ thống của đối tác, mỗi khi dữ liệu của đối tác có sự thay đổi thì tự động gọi đến webhook để đồng bộ dữ liệu sang Gobysend
Quy trình đồng bộ:
Tài liệu gồm 2 phần:
- CRM: Các api CRM cần cung cấp cho Gobysend để có thể đồng bộ dữ liệu từ CRM vào hệ thống của Gobysend
- Gobysend: Các api của Gobysend mà các phần mềm khác có thể sử dụng để đồng bộ dữ liệu từ Gobysend
CRM
CRM là tài liệu mô tả các api mà đối tác cần cung cấp cho Gobysend để đồng bộ dữ liệu về Gobysend
Xác thực
Api do đối tác cung cấp cần xác thực qua API Key. Đối tác cung cấp cho Gobysend một Api key là 1 đoạn mã ngẫu nhiên và duy nhất, mỗi khi Gobysend gọi api đến đối tác đều sẽ gửi kem đoạn mã này trong header với key là X-API-KEY.
Ví dụ: X-API-KEY: 9HzV4BkrWu26Qj6YPIbRPLvvp2kkbQ
Lưu ý: Nếu đối tác đang sử dụng các phương thức xác thực khác thì có thể sử dụng và gửi lại Gobysend tài liệu xác thực
Webhook
Để Gobysend có thể nhận biết và đồng bộ về khách hàng, đơn hàng, sản phẩm, CRM cần cài đặt cơ chế webhook. Mỗi khi có thay đổi gì trên dữ liệu khách hàng, đơn hàng, sản phẩm, CRM thông báo tới Gobysend qua đường dẫn webhook mà Gobysend cung cấp với dữ liệu chính là đối tượng được thay đổi.
Các action webhook mà Gobysend hỗ trợ:
- Thêm mới khách hàng: customer/create
- Sửa khách hàng: customer/update
- Xóa khách hàng: customer/delete
- Thêm mới hóa đơn: order/create
- Cập nhật hóa đơn: order/update
- Bắt đầu giao hàng: order/picking_up
- Giao hàng thành công: order/delivered
- Thanh toán: order/payment
- Thêm mới sản phẩm: product/create
- Sửa sản phẩm: product/update
- Xóa sản phẩm: product/delete
POSTKết nối
Api xác thực api key được cung cấp là chính xác và trả lại thông tin của ứng dụng được kết nối như app_id, tên ứng dụng.
Nếu api key không phải do CRM cung cấp thì trả về lỗi và từ chối kết nối
GETĐồng bộ customer
Api lấy danh sách các customer có thời gian cập nhật lần cuối lớn hơn last_sync_at
Dữ liệu của customer bắt buộc phải có 1 trong 3 trường id, email, phone_number vì đây là những trường định danh của 1 customer