Nhảy đến nội dung

Nút admin-api

Nút admin-api cung cấp quyền truy cập trực tiếp vào API nội bộ của OneEntry. Với nó, bạn có thể đọc và thay đổi đơn hàng, trang, sản phẩm, người dùng, bộ sưu tập và phiên thanh toán ngay từ luồng tích hợp — mà không cần phải viết các yêu cầu HTTP bằng tay.

Cài đặt nút admin-api​

IMG2

1. Tên​

Trường để chỉ định tên của nút.
Tên sẽ hiển thị trong không gian làm việc và giúp dễ dàng nhận diện nút.
Nếu để trống, nút sẽ được gọi là admin-api.

Ví dụ:

  • Tên nút: Tạo Phiên Thanh Toán

2. Loại​

Lựa chọn thao tác API sẽ được gọi khi một thông điệp đi qua nút. Đây là danh sách thả xuống có tìm kiếm: các thao tác được nhóm theo các phần của API, và tên của chúng được lấy từ mô tả API của nút bằng ngôn ngữ giao diện. Nếu không có bản dịch cho ngôn ngữ này, tên sẽ được hiển thị bằng ngôn ngữ gốc.

Tập hợp các thao tác phụ thuộc vào phiên bản OneEntry, vì vậy hãy xem danh sách chính xác trong danh sách thả xuống Loại. Các thao tác bao gồm:

  • trang và sản phẩm — ví dụ, "Cập nhật đối tượng trang", "Tìm kiếm tất cả các đối tượng trang sản phẩm với phân trang và bộ lọc.", lấy nhiều sản phẩm theo các định danh;
  • người dùng — bao gồm tìm kiếm người dùng;
  • giá trị thuộc tính — bao gồm cập nhật giá trị thuộc tính của nhiều thực thể cùng một lúc;
  • đơn hàng — thay đổi trạng thái đơn hàng, áp dụng kích hoạt trạng thái, hoàn trả;
  • phiên thanh toán — ví dụ, "Tạo phiên thanh toán" và "Cập nhật phiên thanh toán";
  • số dư thưởng — điều chỉnh thủ công số dư của người dùng;
  • bản ghi bộ sưu tập — ví dụ, "Lấy tất cả các bản ghi thuộc về một bộ sưu tập.".

Sau khi chọn thao tác, các trường Tham số truy vấn và Nội dung yêu cầu sẽ được điền bằng ví dụ từ mô tả API — chỉ cần thay thế các giá trị của bạn.

3. Tham số truy vấn​

Tham số của yêu cầu. Đường dẫn và phương thức HTTP của nút được lấy tự động từ thao tác đã chọn, không thể chỉnh sửa trong biểu mẫu. Các giá trị của tham số đường dẫn (ví dụ, định danh bản ghi) được chỉ định trong cùng một trường với các tham số URL của yêu cầu.

Trường này sử dụng cú pháp Mustache — các giá trị từ msg có thể được thay thế qua {{biến}}.

Ví dụ (cho thao tác "Lấy tất cả các bản ghi thuộc về một bộ sưu tập."):

{
  "entityType": "orders",
  "entityId": "{{orderId}}",
  "langCode": "en_US",
  "offset": 0,
  "limit": 1,
  "marker": "delivery"
}

4. Nội dung yêu cầu​

Nội dung của yêu cầu ở định dạng JSON. Trường này chỉ hiển thị cho các thao tác với các phương thức POST, PUT và PATCH. Hỗ trợ Mustache để thay thế dữ liệu từ msg.

Ví dụ (cho thao tác "Tạo phiên thanh toán"):

{
  "orderId": {{orderId}},
  "type": "session"
}

5. Sơ đồ đầu vào​

Khối Sơ đồ đầu vào hiển thị trong cài đặt của nút và cho thấy cấu trúc dữ liệu đến từ nút trước trong luồng. Sơ đồ được trình bày dưới dạng các 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 các trường trong sơ đồ có trong mô tả API, mô tả văn bản sẽ được hiển thị bên cạnh chúng. Những mô tả này cũng được trình biên tập mã nhận diện dưới dạng gợi ý khi viết các mẫu Mustache.

Ví dụ về hiển thị Sơ đồ đầu vào:

payload
  └── order
        ├── id           (integer)  — Định danh đơn hàng
        ├── status       (string)   — Trạng thái hiện tại
        └── totalPrice   (number)   — Tổng số tiền

6. Nút Thực thi​

Nút Thực thi cho phép gọi yêu cầu API ngay từ biểu mẫu chỉnh sửa nút, mà không cần khởi động toàn bộ luồng.

Cách hoạt động:

  • Máy chủ thực hiện toàn bộ luồng từ đầu đến nút này, truyền dữ liệu theo chuỗi theo trạng thái đã công bố gần nhất của luồng.
  • Nếu bất kỳ nút function nào trên đường đi không truyền dữ liệu tiếp, nhưng có trường Ví dụ đầu ra (JSON) được điền, dữ liệu này sẽ được sử dụng làm dữ liệu thử nghiệm.
  • Trong trường hợp phản hồi thành công, phản hồi API sẽ được truyền đến nút tiếp theo dưới dạng sơ đồ.
  • Nếu yêu cầu trả về lỗi — sơ đồ sẽ không được truyền đến nút tiếp theo.
thông tin

Trước khi sử dụng nút Thực thi, hãy đảm bảo rằng luồng đã được công bố. Máy chủ thực hiện chuỗi theo trạng thái của lần công bố cuối cùng.

Ảnh hưởng đến sơ đồ:

Nút admin-api ban đầu có sơ đồ phản hồi từ mô tả API. Khi nhấn Thực thi, sơ đồ sẽ được ghi đè bằng phản hồi thực tế từ API. Trong khi đó, các trường trùng khớp với mô tả API sẽ giữ nguyên mô tả văn bản của chúng.

7. Gọi tự động các yêu cầu 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,
  • khi cập nhật luồng qua nút Công bố.

Điều này cho phép luôn có sơ đồ dữ liệu cập nhật trong nút tiếp theo mà không cần khởi động thủ công.

Ví dụ sử dụng​

Ví dụ 1: Tạo phiên thanh toán​

Cài đặt nút:

  • Loại: Tạo phiên thanh toán
  • Nội dung yêu cầu: 
    {
      "orderId": {{orderEvent.order.id}},
      "type": "session"
    }

Kết quả:
Nút tạo một phiên thanh toán, sử dụng orderId từ thông điệp đầu vào, và truyền dữ liệu của phiên mới đến nút tiếp theo.

Ví dụ 2: Cập nhật trạng thái đơn hàng​

Cài đặt nút:

  • Loại: Cập nhật trạng thái của một đơn hàng thuộc đối tượng lưu trữ đơn hàng
  • Tham số truy vấn: 
    {
      "id": {{orderId}}
    }
  • Nội dung yêu cầu: 
    {
      "status": "{{newStatus}}"
    }

Kết quả:
Nút cập nhật trạng thái đơn hàng, sử dụng dữ liệu từ thông điệp đầu vào.

Ví dụ 3: Lấy các bản ghi bộ sưu tập​

Cài đặt nút:

  • Loại: Lấy tất cả các bản ghi thuộc về một bộ sưu tập.
  • Tham số truy vấn: 
    {
      "entityType": "delivery",
      "entityId": "{{payload.id}}",
      "langCode": "en_US",
      "offset": 0,
      "limit": 10
    }

Kết quả:
Nút trả về danh sách các bản ghi của bộ sưu tập. Vì đây là yêu cầu chỉ đọc, khi mở trang, sơ đồ phản hồi sẽ được tải tự động.