Nhảy đến nội dung

Giới thiệu

Mô-đun "Tích hợp" cho phép dễ dàng kết hợp API và dịch vụ trực tuyến thông qua lập trình trực quan. Mô-đun cung cấp một giao diện thân thiện, nơi bạn có thể kéo và thả các khối nút, tạo ra logic cho ứng dụng của bạn một cách trực quan. Điều này đơn giản hóa quá trình phát triển, làm cho nó trở nên dễ tiếp cận ngay cả với những người không phải là lập trình viên chuyên nghiệp, và tăng tốc đáng kể quá trình tích hợp các hệ thống khác nhau:

Các yếu tố chính của giao diện mô-đun Tích hợp​

Trước khi bắt đầu tạo các luồng và tích hợp đầu tiên của bạn, hãy cùng tìm hiểu về giao diện. Hiểu cách các yếu tố chính hoạt động sẽ giúp công việc của bạn dễ dàng hơn và giúp bạn nhanh chóng làm quen.

1. Bảng bên trái với các nút​

Bảng bên trái là nơi bạn sẽ tìm thấy tất cả các nút có sẵn. Đây là các yếu tố mà bạn sẽ sử dụng để xây dựng các luồng dữ liệu của mình.

Để sử dụng một nút, chỉ cần kéo nó vào khu vực làm việc. Tất cả các nút đều có chức năng riêng và có thể được cấu hình riêng lẻ.

Ví dụ về các nút:

  • Inject: cho phép gửi dữ liệu vào luồng một cách thủ công.
  • Debug: hiển thị dữ liệu và thông báo trong menu gỡ lỗi.
  • Function: cho phép viết mã tùy chỉnh bằng JavaScript.
  • Template: được sử dụng để tạo các mẫu văn bản hoặc HTML.

2. Các tab​

Các tab nằm ở trên khu vực làm việc và cho phép bạn chuyển đổi giữa các dự án hoặc luồng dữ liệu khác nhau. Điều này rất tiện lợi nếu bạn đang làm việc trên nhiều tích hợp cùng một lúc hoặc muốn chia logic thành nhiều luồng.

  • Tạo Tab Mới: Bạn có thể thêm một tab mới bằng cách nhấp vào nút cộng +. Mỗi tab mới đại diện cho một luồng dữ liệu riêng biệt, giúp bạn tổ chức dự án tốt hơn.
  • Đổi Tên Tab: Để đổi tên tab, hãy nhấp đúp vào tên của nó và nhập tên mới. Điều này đặc biệt hữu ích nếu bạn có nhiều tab và muốn hiểu rõ nội dung của từng tab.
  • Xóa Tab: Nhấp chuột phải vào tab và chọn mục Delete trong menu ngữ cảnh. Hãy cẩn thận để không mất dữ liệu quan trọng.
  • Vô hiệu hóa Tab: Trong cùng một menu ngữ cảnh, mục Disable sẽ vô hiệu hóa luồng của tab mà không xóa nó. Tab đã bị vô hiệu hóa sẽ có mục gọi là Enable — nó sẽ kích hoạt lại luồng. Trong sơ đồ JSON, trạng thái này được lưu trong trường disabled của tab.

Ví dụ: Nếu bạn đang làm việc trên tích hợp thanh toán, bạn có thể tạo các tab riêng cho mỗi dịch vụ.

3. Khu vực làm việc​

Khu vực làm việc là phần trung tâm của giao diện, nơi bạn xây dựng và chỉnh sửa các luồng dữ liệu của mình.

  • Đặt Nút: Sau khi bạn kéo một nút từ bảng bên trái, nó sẽ xuất hiện trong khu vực làm việc. Tại đây, bạn có thể di chuyển nó, kết nối với các nút khác và tạo ra logic cho luồng của bạn.
  • Kết Nối Nút: Để kết nối các nút, chỉ cần kéo một đường từ đầu ra của một nút đến đầu vào của nút khác. Bằng cách này, dữ liệu sẽ được truyền qua luồng từ nút này sang nút khác.
  • Quản Lý Luồng: Khu vực làm việc cho phép tạo nhiều luồng dữ liệu, giúp tổ chức các tích hợp phức tạp và logic.

Mẹo: Bạn có thể phóng to khu vực làm việc bằng chuột hoặc bàn di cảm ứng để xem tất cả các chi tiết của luồng của bạn.

4. Biểu mẫu chỉnh sửa nút​

Khi bạn nhấp đúp vào một nút trong khu vực làm việc, một biểu mẫu chỉnh sửa nút sẽ mở ra. Đây là cửa sổ mà bạn cấu hình hành vi của nút.

  • Các Trường Cài Đặt: Mỗi nút có các tham số riêng mà bạn có thể chỉnh sửa. Ví dụ, trong nút Function, bạn có thể viết và chỉnh sửa mã.
  • Lưu Thay Đổi: Sau khi chỉnh sửa nút, hãy nhấn nút Submit để lưu các thay đổi.

Ví dụ: Trong nút Function, bạn có thể viết mã JavaScript để chuyển đổi dữ liệu. Trong nút Template, bạn có thể tạo một mẫu mà tự động chèn dữ liệu.

5. Bảng gỡ lỗi​

Bảng gỡ lỗi nằm bên phải và được sử dụng để xem dữ liệu đầu ra và thông báo từ nút Debug. Bảng có hai tab: Debug — thông báo của luồng và Configuration.

  • Xem Thông Báo: Khi bạn chạy luồng dữ liệu, nút Debug sẽ gửi thông báo đến tab Debug. Điều này giúp bạn thấy những gì đang xảy ra trong luồng của bạn và kiểm tra tính chính xác của dữ liệu.
  • Lọc Thông Báo: Danh sách trên các thông báo cho phép bạn chọn thông báo từ nút nào sẽ hiển thị: all nodes — từ tất cả các nút, current workflow — chỉ từ các nút của tab hiện tại. Điều này rất tiện lợi khi bạn có nhiều dữ liệu đầu ra từ các nút Debug khác nhau.
  • Xóa Cửa Sổ Gỡ Lỗi: Nhấn vào biểu tượng dấu x bên cạnh bộ lọc để xóa các thông báo cũ và tập trung vào dữ liệu mới.

Ví dụ: Nếu bạn sử dụng nút Function để thực hiện các phép tính, hãy thêm nút Debug vào cuối luồng để kiểm tra xem mã của bạn có xử lý dữ liệu đúng không.

6. Các nút điều khiển​

Nút "Mở toàn màn hình"​

  • Nút này cho phép mở rộng giao diện của mô-đun Tích hợp ra toàn màn hình, điều này rất hữu ích khi làm việc với các luồng dữ liệu phức tạp hoặc khi trình bày dự án trên màn hình lớn.
  • Nhấn vào nút này, bạn sẽ có nhiều không gian hơn để chỉnh sửa và có thể nhìn thấy tất cả các chi tiết của luồng của bạn tốt hơn.

Nút "Xuất bản"​

  • Đây là nút chính, lưu và triển khai tất cả các thay đổi đã thực hiện trong các luồng dữ liệu của bạn, làm cho chúng trở nên hoạt động. Sau khi bạn thêm hoặc thay đổi các nút, hãy chắc chắn nhấn nút này để các cài đặt của bạn bắt đầu hoạt động.

Nút "Nhập"​

  • Nút này cho phép nhập một sơ đồ hiện có từ JSON hoặc một ví dụ từ danh sách. Bạn có thể tìm hiểu thêm trong phần Nhập.

Sơ đồ đầu vào và truyền sơ đồ giữa các nút​

Mỗi nút trong biểu mẫu chỉnh sửa hiển thị khối Sơ đồ đầu vào — đây là sơ đồ dữ liệu đến từ nút trước đó trong luồng. Sơ đồ hiển thị các trường có sẵn dưới dạng cặp "khóa - loại", với sự xem xét đến độ lồng ghép của các đối tượng.

Nếu mô tả trường có trong mô tả API, nó sẽ được hiển thị bên cạnh khóa. Những mô tả này cũng được trình soạn thảo mã sử dụng dưới dạng tự động hoàn thành và gợi ý khi viết các mẫu Mustache.

Các nút nào truyền sơ đồ đến nút tiếp theo​

Không phải tất cả các nút đều có khả năng truyền sơ đồ. Danh sách các nút có khả năng này:

  • Function — sơ đồ được hình thành từ trường Output Example (JSON). Trường này cũng được sử dụng làm dữ liệu thử nghiệm khi gọi luồng mà không thực sự chạy mã Function.
  • Admin API — sơ đồ được lấy từ mô tả phương thức trong mô tả API. Khi nhấn nút Execute, sơ đồ được cập nhật bằng phản hồi thực tế từ API. Các trường trùng khớp với mô tả API sẽ giữ lại mô tả văn bản của chúng.
  • Http Request — ban đầu không có sơ đồ. Sơ đồ xuất hiện sau khi nhấn nút Execute và được lấy từ phản hồi thực tế.

Nút Execute​

Các nút Admin API và Http Request hỗ trợ nút Execute trong biểu mẫu chỉnh sửa. Nó khởi động việc thực hiện toàn bộ chuỗi nút từ đầu luồng đến nút hiện tại.

Đặc điểm:

  • Máy chủ thực hiện luồng theo trạng thái của lần xuất bản cuối cùng — trước khi thử nghiệm, hãy đảm bảo rằng luồng đã được xuất bản.
  • Nếu nút function trên đường không truyền dữ liệu tiếp, nhưng nó đã điền Output Example (JSON), giá trị này sẽ được sử dụng làm dữ liệu thử nghiệm.
  • Khi có phản hồi thành công, kết quả sẽ được truyền đến nút tiếp theo dưới dạng sơ đồ.
  • Khi có lỗi, sơ đồ sẽ không được truyền đến nút tiếp theo.

Gọi tự động các nút chỉ đọc​

Tất cả các nút admin-api, thực hiện các yêu cầu chỉ đọc (GET), sẽ được gọi tự động khi mở trang Tích hợp và khi cập nhật luồng thông qua nút Publish. Điều này giúp luôn có sơ đồ dữ liệu cập nhật mà không cần khởi động thủ công.