Bỏ qua để đến nội dung
RetionRetionTài liệu

Gửi yêu cầu

(Sử dụng API trong Retion - Tính năng nâng cao, yêu cầu hiểu và nắm được về API trước khi dùng)

Định nghĩa API

  • API (Application Programming Interface) là cách để kết nối đến một phần mềm bạn đang sử dụng.
  • Nhà cung cấp phần mềm sẽ cung cấp tài liệu hướng dẫn kết nối API để bạn thực hiện.
    • Ví dụ: Khi sử dụng Sapo, nếu muốn kết nối để lấy thông tin sản phẩm, bạn cần sử dụng tài liệu API mà Sapo cung cấp.
  • Lưu ý: Mỗi phần mềm có cách kết nối khác nhau, nhưng đều dựa trên các tiêu chuẩn chung sau:
    1. GET / POST:
      • GET: Lấy dữ liệu từ phần mềm (chiều đọc).
      • POST: Gửi dữ liệu đến phần mềm (chiều ghi).
    2. URL: Đường link kết nối API.
    3. Body: Dữ liệu đi kèm cho phương thức POST.
    4. Param: Dữ liệu cho cả GET và POST.
    5. Header: Cấu hình thêm cho cả GET và POST (ví dụ: mã xác thực).

Áp dụng API trong Retion

  • Mục đích: Truyền và nhận dữ liệu giữa Retion và các bên thứ ba.
  • Tính năng cần dùng: Gửi yêu cầu trong Kịch bản.

Cách sử dụng

  1. Tại Kịch bản, chọn tính năng Gửi yêu cầu.
  2. Cài đặt API theo các bước:
    • Chọn phương thức truyền dữ liệu: GET hoặc POST.
    • Điền URL, Body, Param, và Header theo yêu cầu của API bạn muốn kết nối.
  3. Lưu và kiểm tra kết nối API trong kịch bản.

Các phương thức truyền dữ liệu

Lưu ý:

  • Khi lưu kịch bản API báo “Nội dung JSON không hợp lệ” thường do lỗi cú pháp JSON, như:
    - Thiếu/nhầm dấu { }, [ ].
    - Thiếu hoặc thừa dấu phẩy giữa các phần tử.
    - Dùng nháy đơn ' thay vì nháy kép " cho key/chuỗi.
    - Có dấu phẩy cuối phần tử (trailing comma).
    - Ký tự đặc biệt chưa escape (ví dụ dấu " trong chuỗi).
  • Giải pháp:
    - Soát lại toàn bộ JSON
    - Key và chuỗi phải đặt trong "nháy kép".
    - Các cặp key–value cách nhau bằng dấu phẩy, không có dấu phẩy cuối.
    - Không có comment trong JSON.