Yêu cầu API bên ngoài
Giao tiếp với bất kỳ API nào và tích hợp bất kỳ dịch vụ nào.
Yêu cầu API bên ngoài cho phép bạn xác định các mẫu yêu cầu, sau đó kích hoạt lệnh gọi đi tới bất kỳ API nào từ bên trong quy trình kinh doanh. Với chúng, bạn có thể kết nối dự án của mình với bất kỳ dịch vụ của bên thứ ba nào, ngay cả khi chưa có mô-đun nào cho dự án đó trên thị trường.
Sự định nghĩa
Tham khảo thông số kỹ thuật về cách cấu trúc yêu cầu trong tài liệu API của nhà cung cấp dịch vụ mà bạn muốn kết nối.
- Để xác định mẫu yêu cầu mới, hãy chuyển đến tab "Logic nghiệp vụ" trên thanh bên (1), chuyển sang tab "Yêu cầu API bên ngoài" (2) và nhấp vào "Yêu cầu API mới" (3).
3. Chọn phương thức HTTP yêu cầu và URL của nó.
4. Xác định tham số URL, tham số truy vấn (chỉ dành cho yêu cầu GET), tiêu đề và nội dung của yêu cầu bằng cách nhập tên tham số (1), loại tham số (2) và nhấp vào "Thêm tham số" (3).
Giá trị thực của các tham số này sẽ được xác định tại thời điểm thực hiện quy trình nghiệp vụ, nơi yêu cầu được kích hoạt.
Để hiểu sự khác biệt giữa URL và tham số truy vấn, hãy đọc thêm tại đây. Tuy nhiên, bất kể tiêu chuẩn là gì, tài liệu API của nhà cung cấp dịch vụ mà bạn muốn kết nối là nguồn thông tin tốt nhất về cách xây dựng yêu cầu.
Bạn cũng có thể tự động điền các tiêu đề và nội dung yêu cầu bằng cách nhập JSON mẫu, hệ thống sẽ tự động tạo tất cả các tham số cần thiết.
Bạn không phải thêm thông số mới trên mỗi tab. Ví dụ: một số yêu cầu có thể không chứa bất kỳ tham số URL, tiêu đề hoặc nội dung nào.
Trong trường hợp yêu cầu của bạn chứa các đối tượng (ví dụ: ô tô -> màu sắc, kích thước, v.v.), bạn sẽ phải tạo các mô hình ảo để xử lý các đối tượng này sau trong quy trình kinh doanh của mình. Làm như vậy bằng cách chọn "Mô hình" trong bộ chọn loại tham số và giới thiệu các phần tử con mà bạn cần. Bạn có thể lồng các đối tượng bao nhiêu lần tùy ý (tức là đối tượng bên trong đối tượng) và tạo các mảng mô hình ảo. Trong trường hợp bạn đã sử dụng tính năng tự động điền, quá trình này sẽ tự động hoàn tất.
5. Thay đổi cài đặt của yêu cầu, chẳng hạn như xác minh SSL, thời gian chờ và xử lý lỗi trong tab "Cài đặt".
7. Lưu mẫu yêu cầu bằng cách nhấp vào "Lưu yêu cầu".
Sử dụng
Sau khi bạn xác định và lưu một yêu cầu mới, một khối mới sẽ có sẵn trong Trình chỉnh sửa quy trình nghiệp vụ để kích hoạt nó.
Bạn sẽ phải cung cấp cho nó tất cả các thành phần mà bạn muốn thêm vào yêu cầu (URL và tham số truy vấn, tiêu đề và nội dung) dưới dạng mô hình dữ liệu, có thể được tạo bằng cách sử dụng các khối này. Ở đầu ra, bạn sẽ có thể trích xuất nội dung được định dạng của phản hồi, tiêu đề và trạng thái phản hồi. Bạn có thể mở rộng các mô hình này bằng các khối này.
Bạn không cần phải kết nối tất cả các đầu vào dữ liệu để yêu cầu kích hoạt chính xác. Ví dụ: nếu bạn có một yêu cầu không có tham số URL, thì bạn không phải tạo mô hình và kết nối nó.
Đối với mỗi mô hình ảo mà bạn đã xác định, 2 khối mới sẽ được thêm vào Trình chỉnh sửa quy trình nghiệp vụ của bạn để tạo và mở rộng mô hình đó.
Giám sát
Mỗi khi bạn kích hoạt một yêu cầu API, hệ thống sẽ xuất ra nhật ký loại và địa chỉ, nội dung yêu cầu, mã trạng thái HTTP phản hồi và nội dung phản hồi. Bạn có thể xuất thông tin khác, chẳng hạn như các trường cụ thể của nội dung phản hồi hoặc độ trễ của nhật ký bằng cách sử dụng khối Ghi vào Nhật ký.
