Khởi tạo Connector: Dạng API

1. Tổng quan

  • Định nghĩa: Connector dạng API là kênh tiếp nhận dữ liệu thời gian thực (Streaming) thông qua giao thức webhook/API. Thay vì kéo dữ liệu từ nguồn, hệ thống của bạn sẽ chủ động đẩy (POST) dữ liệu sang một endpoint tổng của Mobio.
  • Lợi ích/Giá trị: Đảm bảo dữ liệu được cập nhật ngay lập tức vào chiến dịch tương tác tự động. Endpoint này là điểm tập trung nhận mọi request trước khi phân phối vào luồng xử lý ở phía sau.
  • Đối tượng sử dụng: Kỹ sư dữ liệu (Data Engineer), Lập trình viên Backend hệ thống đối tác.

2. Giải thích Thuật ngữ & Thông số

  • Request Method: Phương thức giao tiếp mặc định của cổng này là POST.
  • Request Header (Header xác thực): Cặp Key-Value dùng để nhận diện và xác thực quyền bắn data vào Mobio (Sử dụng AppKey).
  • Body Payload: Cấu trúc đóng gói dữ liệu, hệ thống mặc định giới hạn định dạng JSON và bulk limit là 200 bản tin/request.

3. Điều kiện tiên quyết (Prerequisite)

  • Bài viết trước: Tổng quan luồng vận hành Data Flow – Nguồn dữ liệu
  • Khởi tạo ứng dụng: Bạn phải tạo sẵn một ứng dụng (Application) trên hệ thống Mobio để phụ trách việc Authenticate (sinh AppKey) trước khi bắt tay cấu hình Connector API. Xem hướng dẫn Quản lý Ứng dụng (Application) tại đây.
  • Phân quyền: Tài khoản Mobio phải được cấp quyền RBAC: INTERGRATION > Cài đặt > Cài đặt DN > Đồng bộ dữ liệu > Data Flow > Nguồn dữ liệu. Xem hướng dẫn phân quyền truy cập RBAC tại đây.
  • Đường dẫn truy cập:
    • Cài đặt → Tích hợp dữ liệu → Kết nối → Nguồn dữ liệu → Tạo nguồn dữ liệu mới, hoặc
    • Cài đặt → Tích hợp dữ liệu → Data Flow → Nguồn dữ liệu → Thêm mới.

4. Các bước thực hiện

Bước 1: Khởi tạo Connector API

  • Truy cập vào giao diện quản lý Nguồn dữ liệu.
  • Chọn Thêm nguồn dữ liệu mới → Chọn HTTP API.

Bước 2: Khai báo thông tin định danh

  • Tên nguồn: Điền định danh để phân biệt (Tối đa 200 ký tự). Nhập chính xác, tên này không được trùng nhau trên toàn Tenant.
  • Mô tả nguồn: Giải thích luồng dữ liệu (Tối đa 500 ký tự).

Bước 3: Khai báo thông tin xác thực nguồn (Credentials)

  • Request URL: Hệ thống mặc định điền sẵn Endpoint API tổng của Mobio. Bạn có thể nhấn Copy để gửi cho đội Dev.
  • Ứng dụng (Application): Bấm Dropdown chọn tên ứng dụng đã xác thực.
  • Phương thức: Mặc định là POST (Không được sửa).
  • Request Header: Khi chọn xong Ứng dụng, hệ thống lập tức xổ ra 4 thuộc tính bảo mật (không cho phép sửa):
    • X-Merchant-ID
    • Mobio-Connector-Identifier
    • Mobio-Access-Token
    • Mobio-Connector-AppKey
  • Bấm + Thêm mới nếu bạn có nhu cầu truyền thêm các cặp key-value tùy biến (Tối đa 50 cặp).
  • Query Parameter: Chuỗi mã hoá tự động sinh kèm theo tham số bảo mật của Application (Ví dụ ?x-merchant-id=...). Không được sửa.
  • Request Body: Mặc định application/json (Không được sửa)

Bước 4: Lưu thông tin kết nối

  • Khác với Connector Database, loại Connector API của Mobio LUÔN LUÔN trả về phản hồi 200 OK. Do vậy, phần này lược bỏ bước “Kiểm tra kết nối thử nghiệm”.
  • Bấm Lưu. Trạng thái kết nối sẽ được chuyển thành BẬT KẾT NỐI.

5. Quy tắc vận hành

  • Giới hạn Bulk Request: Mỗi lô Request (Bulk size limit) đưa vào API chỉ chứa tối đa 200 bản tin/request.
  • Email Cảnh báo (Notification Alert): Khi hệ thống xử lý API đồng bộ, mặc định tính năng nhận báo cáo email đang tắt. Bạn có thể bật cấu hình này và nhập email chỉ định để mỗi ngày nhận 3 báo cáo (lúc 9h, 14h, 18h) theo giờ định kỳ của Mobio. Báo cáo Tắt kết nối sẽ được gửi ngay lập tức (Real-time).

6. Các câu hỏi thường gặp (FAQ)

  • Hỏi: Nếu cùng một Application có thể gán cho nhiều Connector khác nhau được không?
    • Trả lời: Có. Bạn hoàn toàn có thể cấp chung 1 chứng thực AppKey (Application) cho nhiều nguồn dữ liệu/đích dữ liệu khác nhau để tiện quản lý.
  • Hỏi: Tại sao tôi đẩy API Form-data hoặc Upload file, XML vào thì báo lỗi?
    • Trả lời: Ở phiên bản hiện tại, Endpoint cổng API Data Flow chỉ nhận diện định dạng duy nhất là JSON. Các định dạng mã hóa khác sẽ không được hỗ trợ.

7. Bước tiếp theo

Báo cáo Connector API

image-zoom
© MOBIO 2022 v1.3 Powered by MOBIO
Back to Top