Định cấu hình chính sách ghi lại giao dịch

Bạn đang xem tài liệu về Apigee Edge.
Chuyển đến Tài liệu về Apigee X. thông tin

Định cấu hình chính sách ghi giao dịch cho từng sản phẩm API trong gói sản phẩm API của bạn như mô tả trong các phần sau.

Giới thiệu

Chính sách ghi lại giao dịch cho phép bạn kiếm tiền bằng cách thu thập các thông số giao dịch và thuộc tính tuỳ chỉnh. Tính năng kiếm tiền cần thông tin này để xử lý hoạt động kiếm tiền chẳng hạn như áp dụng gói giá.

Ví dụ: nếu bạn thiết lập kế hoạch tỷ lệ chia sẻ doanh thu, tỷ lệ phần trăm doanh thu kiếm được từ mỗi giao dịch liên quan đến sản phẩm API kiếm tiền của bạn sẽ được chia sẻ khi nhà phát triển ứng dụng đưa ra yêu cầu. Phần doanh thu chia sẻ được tính dựa trên giá trị ròng hoặc tổng doanh thu giá của giao dịch (bạn chỉ định giá nào), tức là tỷ lệ phần trăm của tổng giá hoặc giá ròng của mỗi giao dịch được dùng để xác định tỷ lệ chia sẻ doanh thu. Vì vậy, hoạt động kiếm tiền cần phải để biết tổng giá hoặc giá ròng của một giao dịch (nếu có). Nó lấy tổng giá hoặc giá ròng từ các chế độ cài đặt bạn thực hiện trong chính sách ghi lại giao dịch.

Nếu bạn thiết lập bảng giá nơi bạn tính phí nhà phát triển cho mỗi giao dịch, bạn có thể đặt mức giá cho gói dựa trên thuộc tính tuỳ chỉnh, chẳng hạn như số byte được truyền trong một giao dịch. Hoạt động kiếm tiền cần biết thuộc tính tuỳ chỉnh là gì và cách tìm thuộc tính đó. Do đó, bạn cần chỉ định thuộc tính tuỳ chỉnh trong chính sách ghi lại giao dịch.

Ngoài việc chỉ định các thuộc tính giao dịch trong chính sách ghi lại giao dịch, bạn có thể chỉ định tiêu chí thành công của giao dịch để xác định thời điểm giao dịch thành công (đối với mục đích sạc). Để biết ví dụ về cách thiết lập tiêu chí thành công của giao dịch, hãy xem Ví dụ về cách thiết lập tiêu chí giao dịch thành công trong bản ghi giao dịch . Bạn cũng có thể chỉ định các thuộc tính tuỳ chỉnh cho một sản phẩm API (mà bạn dựa vào đó để đặt giá cơ sở gói dịch vụ).

Định cấu hình chính sách ghi lại giao dịch

Truy cập vào trang Gói sản phẩm theo mô tả dưới đây.

Định cấu hình thuộc tính giao dịch

Trong phần Thuộc tính giao dịch, hãy chỉ định tiêu chí cho thấy giao dịch kiếm tiền thành công.

1. Trong trường Tiêu chí giao dịch thành công, hãy chỉ định biểu thức dựa trên giá trị của thuộc tính Trạng thái (mô tả tiếp theo) để xác định thời điểm giao dịch thành công (cho mục đích tính phí). Những giao dịch không thành công (tức là các giá trị này không đáp ứng tiêu chí trong biểu thức) được ghi lại, nhưng gói giá không được áp dụng cho các gói giá đó. Ví dụ:

   txProviderStatus == 'OK'

2. Thuộc tính Status (Trạng thái) chứa giá trị được sử dụng bởi biểu thức được định cấu hình trong trường Tiêu chí giao dịch thành công. Định cấu hình thuộc tính Status (Trạng thái) bằng cách xác định các trường sau:

   Trường	Mô tả
   Tài nguyên API	Mẫu URI được xác định trong sản phẩm API sẽ dùng để xác định giao dịch có thể kiếm tiền.
   Vị trí phản hồi	Vị trí của phản hồi, trong đó thuộc tính được chỉ định. Các giá trị hợp lệ bao gồm: Biến luồng, Tiêu đề, Nội dung JSON và Nội dung XML.
   Giá trị	Giá trị của phản hồi. Để chỉ định nhiều giá trị, hãy nhấp vào + Thêm x (ví dụ: + Thêm biến luồng).

3. Để định cấu hình các thuộc tính giao dịch không bắt buộc, hãy bật nút bật/tắt Sử dụng thuộc tính không bắt buộc và định cấu hình bất kỳ thuộc tính giao dịch nào được xác định trong bảng sau.

   Thuộc tính	Mô tả
   Tổng giá	Thuộc tính này chỉ áp dụng cho những gói giá sử dụng mô hình chia sẻ doanh thu. Đối với các gói giá đó, giá gộp hoặc Giá thực là bắt buộc. Đảm bảo rằng giá trị số được biểu thị dưới dạng loại Chuỗi. Tổng giá cho một giao dịch. Cho kế hoạch chia sẻ doanh thu, bạn cần ghi lại thuộc tính Tổng giá hoặc Giá thực . Thuộc tính bắt buộc tuỳ thuộc vào cơ sở chia sẻ doanh thu. Cho Ví dụ: bạn có thể lập kế hoạch tỷ lệ chia sẻ doanh thu dựa trên tổng giá của một giao dịch. Trong trường hợp đó, trường Giá tổng là bắt buộc.
   Giá tịnh	Thuộc tính này chỉ áp dụng cho những gói giá sử dụng mô hình chia sẻ doanh thu. Đối với các gói giá đó, giá gộp hoặc Giá thực là bắt buộc. Đảm bảo rằng giá trị số được biểu thị dưới dạng loại Chuỗi. Giá ròng của một giao dịch. Cho kế hoạch chia sẻ doanh thu, bạn cần ghi lại trường Giá thực hoặc Giá tổng . Trường nào là bắt buộc tuỳ thuộc vào cơ sở chia sẻ doanh thu. Ví dụ: bạn có thể thiết lập kế hoạch tỷ lệ chia sẻ doanh thu dựa trên giá ròng của một giao dịch. Trong trường hợp đó, trường Giá thực là bắt buộc.
   Đơn vị tiền tệ	Đây là thuộc tính bắt buộc đối với những gói giá sử dụng mô hình chia sẻ doanh thu. Loại đơn vị tiền tệ áp dụng cho giao dịch.
   Mã lỗi	Mã lỗi liên quan đến giao dịch. Chiến dịch này cung cấp thêm thông tin về giao dịch không thành công.
   Mô tả mặt hàng	Nội dung mô tả về giao dịch.
   Thuế	Thuộc tính này chỉ áp dụng cho các mô hình chia sẻ doanh thu và chỉ khi số tiền thuế được ghi lại trong lệnh gọi API. Đảm bảo rằng giá trị số được thể hiện dưới dạng loại Chuỗi. Số tiền thuế trên giao dịch mua. Giá ròng cộng thuế = tổng giá.

Ví dụ: bằng cách đặt các giá trị sau, tính năng kiếm tiền sẽ nhận được giá trị của biến luồng từ nội dung phản hồi tin nhắn trong một biến có tên là response.reason.phrase. Nếu giá trị này là OK và chính sách Kiểm tra giới hạn kiếm tiền là được đính kèm với yêu cầu ProxyEndpoint API proxy, hoạt động kiếm tiền sẽ tính đó là một giao dịch.

Định cấu hình thuộc tính tuỳ chỉnh

Trong phần Thuộc tính tuỳ chỉnh, bạn xác định các thuộc tính tuỳ chỉnh để đưa vào chính sách ghi lại giao dịch. Ví dụ: nếu bạn thiết lập một gói giá, trong đó bạn tính phí nhà phát triển cho mỗi gói giao dịch, bạn có thể đặt mức giá cho gói dựa trên một thuộc tính tuỳ chỉnh, chẳng hạn như số lượng byte được truyền trong một giao dịch. Sau đó, bạn cần đưa thuộc tính tùy chỉnh đó vào chính sách ghi lại giao dịch.

Mỗi thuộc tính này được lưu trữ trong nhật ký giao dịch và bạn có thể truy vấn nhật ký giao dịch. Chúng cũng được hiển thị khi bạn tạo một gói giá (để bạn có thể chọn một hoặc nhiều thuộc tính này trên để làm cơ sở cho gói của bạn).

Bạn có thể thêm các thuộc tính tuỳ chỉnh được xác định trong chính sách ghi lại giao dịch vào phần doanh thu của mình như được mô tả trong Bao gồm giao dịch tuỳ chỉnh trong báo cáo tóm tắt doanh thu.

Để định cấu hình thuộc tính tuỳ chỉnh, hãy bật nút bật/tắt Sử dụng thuộc tính tuỳ chỉnh và xác định tối đa 10 thuộc tính tuỳ chỉnh. Đối với mỗi thuộc tính tùy chỉnh mà bạn đưa vào chính sách ghi lại giao dịch, bạn cần chỉ định thông tin sau.

Liên kết các tài nguyên bằng mã giao dịch duy nhất

Một số giao dịch rất đơn giản, liên quan đến lệnh gọi API đến một tài nguyên. Tuy nhiên, các thành phần khác thì giao dịch có thể phức tạp hơn. Ví dụ: giả sử một giao dịch để mua hàng trong ứng dụng trong ứng dụng trò chơi dành cho thiết bị di động liên quan đến nhiều lệnh gọi tài nguyên:

• Lệnh gọi đến API đặt trước nhằm đảm bảo rằng người dùng trả trước có đủ tín dụng để mua và phân bổ ("dự trữ") số tiền cho giao dịch mua đó.
• Lệnh gọi đến API tính phí để khấu trừ tiền từ tài khoản của người dùng trả trước.

Để xử lý toàn bộ giao dịch, hoạt động kiếm tiền cần có một cách liên kết tài nguyên đầu tiên ( lệnh gọi và phản hồi đến và từ API dự trữ) bằng tài nguyên thứ hai (lệnh gọi và phản hồi cho và thông qua API tính phí). Để thực hiện việc này, Google sẽ dựa trên thông tin mà bạn chỉ định trong Mục Liên kết tài nguyên bằng mã giao dịch duy nhất.

Để định cấu hình thuộc tính tuỳ chỉnh, hãy bật nút chuyển và đường liên kết Sử dụng mã giao dịch duy nhất các giao dịch. Đối với mỗi giao dịch, bạn chỉ định tài nguyên, vị trí phản hồi và giá trị thuộc tính được liên kết với các giá trị tương ứng trong giao dịch.

Ví dụ: giả sử lệnh gọi API đặt trước và lệnh gọi API tính phí được liên kết như sau: a trường có tên session_id trong tiêu đề phản hồi từ API dự trữ tương ứng với một tiêu đề phản hồi có tên reference_id trong API tính phí. Trong trường hợp này, bạn có thể đặt các mục nhập trong phần Tài nguyên liên kết bằng mã giao dịch duy nhất như sau:

Định cấu hình chính sách hoàn tiền

Trong phần Hoàn tiền, bạn chỉ định các thuộc tính kiếm tiền để xử lý tiền hoàn lại.

Ví dụ: giả sử người dùng mua sản phẩm từ ứng dụng dành cho thiết bị di động sử dụng API kiếm tiền của bạn. Giao dịch được kiếm tiền dựa trên chia sẻ kế hoạch doanh thu. Tuy nhiên, giả sử người dùng không hài lòng với sản phẩm và muốn trả lại sản phẩm đó. Nếu được hoàn lại bằng lệnh gọi đến API để thực hiện việc hoàn tiền, tính năng kiếm tiền giúp những điều chỉnh cần thiết đối với việc kiếm tiền. Việc này dựa trên thông tin mà bạn chỉ định trong Mục Hoàn tiền trong chính sách ghi lại giao dịch.

Để định cấu hình việc hoàn tiền, hãy bật nút chuyển Sử dụng thuộc tính tiền hoàn lại và xác định thông tin chi tiết về việc hoàn tiền:

1. Xác định tiêu chí hoàn tiền bằng cách xác định các trường sau:

   Trường	Mô tả
   Vị trí phản hồi	Tài nguyên dành cho giao dịch hoàn tiền. Nếu sản phẩm API cung cấp nhiều tài nguyên, bạn chỉ có thể chọn tài nguyên thực hiện hoàn lại tiền.
   Tiêu chí hoàn tiền thành công	Biểu thức dựa trên giá trị của thuộc tính Trạng thái (được mô tả trong phần tiếp theo) để xác định thời điểm giao dịch hoàn tiền thành công (để tính phí ). Các giao dịch hoàn tiền không thành công (tức là, chúng không đáp ứng các tiêu chí trong biểu thức) được ghi lại, nhưng gói giá sẽ không được áp dụng cho các gói đó. Ví dụ: txProviderStatus == 'OK'

2. Định cấu hình thuộc tính Status (Trạng thái) bằng cách xác định các trường sau:

   Trường	Mô tả
   Vị trí phản hồi	Vị trí của phản hồi, trong đó thuộc tính được chỉ định. Các giá trị hợp lệ bao gồm: Biến luồng, Tiêu đề, Nội dung JSON và Nội dung XML.
   Giá trị	Giá trị của phản hồi. Để chỉ định nhiều giá trị, hãy nhấp vào + Thêm x (ví dụ: + Thêm biến luồng).

3. Định cấu hình thuộc tính Mã nhận dạng mẹ bằng cách xác định các trường sau:

   Trường	Mô tả
   Vị trí phản hồi	Vị trí của phản hồi, trong đó thuộc tính được chỉ định. Các giá trị hợp lệ bao gồm: Biến luồng, Tiêu đề, Nội dung JSON và Nội dung XML.
   Giá trị	Mã của giao dịch được xử lý việc hoàn tiền. Ví dụ: nếu người dùng mua sản phẩm và sau đó yêu cầu hoàn tiền, Mã giao dịch chính là mã của giao dịch mua. Để chỉ định nhiều giá trị, hãy nhấp vào + Thêm x (ví dụ: + Thêm biến luồng).

4. Để định cấu hình các thuộc tính hoàn tiền không bắt buộc, hãy bật nút bật/tắt Sử dụng các thuộc tính hoàn tiền không bắt buộc và định cấu hình các thuộc tính đó. Các thuộc tính hoàn tiền tùy chọn cũng giống như các thuộc tính giao dịch tùy chọn, như được xác định trong Định cấu hình thuộc tính giao dịch.

Quản lý các chính sách ghi lại giao dịch bằng API

Các phần sau đây mô tả cách quản lý chính sách ghi lại giao dịch bằng API.

Tạo chính sách ghi lại giao dịch bằng API

Bạn chỉ định chính sách ghi giao dịch làm thuộc tính của sản phẩm API. Giá trị của thuộc tính xác định:

• Hậu tố URI của tài nguyên sản phẩm áp dụng cho chính sách ghi lại giao dịch được đính kèm. Hậu tố này bao gồm một biến mẫu được đặt trong dấu ngoặc nhọn. Mẫu được Dịch vụ API đánh giá trong thời gian chạy. Ví dụ: hậu tố URI sau đây bao gồm biến mẫu {id}.

  /reserve/{id}**
  

  Trong trường hợp này, Dịch vụ API sẽ đánh giá hậu tố URI của tài nguyên dưới dạng /reserve theo sau là một thư mục con bắt đầu bằng mã nhận dạng do API xác định Google Cloud.

• Tài nguyên trong phản hồi mà nó được đính kèm. Một sản phẩm API có thể có nhiều và mỗi tài nguyên có thể có chính sách ghi giao dịch đi kèm với phản hồi từ tài nguyên đó.
• Chính sách biến trích xuất cho phép chính sách ghi lại giao dịch trích xuất nội dung từ một thông báo phản hồi cho các thông số giao dịch mà bạn muốn thu thập.

Bạn thêm thuộc tính chính sách ghi giao dịch vào một sản phẩm API bằng cách gửi yêu cầu PUT vào API quản lý https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id} (chứ không phải API kiếm tiền).

Chỉ định tiêu chí thành công của giao dịch bằng API

Bạn có thể chỉ định tiêu chí thành công của giao dịch để xác định thời điểm giao dịch thành công (để sạc). Những giao dịch không thành công (tức là những giao dịch đó đáp ứng các tiêu chí trong biểu thức) được ghi lại, nhưng gói giá không được áp dụng cho các gói giá đó. Để xem ví dụ về chế độ cài đặt tiêu chí thành công của giao dịch, xem Ví dụ về cách thiết lập tiêu chí thành công của giao dịch trong chính sách ghi lại giao dịch.

Bạn chỉ định tiêu chí thành công của giao dịch làm thuộc tính của sản phẩm API. Thực hiện việc này bằng cách đưa ra yêu cầu PUT đến API quản lý https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id} (chứ không phải API Kiếm tiền).

Ví dụ: trong yêu cầu sau, một giao dịch được thực hiện nếu giá trị của txProviderStatus là success (tiêu chí liên quan đến giao dịch thành công được đánh dấu).

$ curl -H "Content-Type: application/json" -X PUT -d \ 
'{
        "apiResources": [
        "/reserve/{id}**"       
        ],
        "approvalType": "auto",
        "attributes": [                         
        {
                "name": "MINT_TRANSACTION_SUCCESS_CRITERIA",
                "value": "txProviderStatus == 'OK'"
        }
        ],
        "description": "Payment",
        "displayName": "Payment",
        "environments": [
        "dev"
        ],
        "name": "payment",
        "proxies": [],
        "scopes": [
        ""
        ]
}' \
"https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/payment" \
-u email:password

Chỉ định thuộc tính tuỳ chỉnh bằng API

Bạn có thể chỉ định thuộc tính tuỳ chỉnh cho một sản phẩm API mà bạn tính phí cho gói giá cơ bản. Cho ví dụ: nếu bạn thiết lập một gói bảng giá, trong đó bạn tính phí nhà phát triển cho mỗi giao dịch, bạn có thể đặt tốc độ cho gói thuê bao dựa trên một thuộc tính tuỳ chỉnh như số byte đã truyền trong một giao dịch. Khi tạo một gói giá, bạn có thể chỉ định một hoặc nhiều thuộc tính tuỳ chỉnh trên để lấy mức giá cho gói dịch vụ. Tuy nhiên, mọi sản phẩm cụ thể trong một gói giá chỉ có thể có một thuộc tính tuỳ chỉnh làm giá phòng cho gói dịch vụ.

Bạn chỉ định thuộc tính tuỳ chỉnh làm thuộc tính của một sản phẩm API. Thực hiện việc này bằng cách tạo một PUT yêu cầu tới API quản lý https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id} (chứ không phải API Kiếm tiền).

Đối với mỗi thuộc tính tuỳ chỉnh mà bạn thêm vào một sản phẩm API, bạn cần chỉ định tên và giá trị thuộc tính. Tên phải ở dạng MINT_CUSTOM_ATTRIBUTE_{num}, trong đó {num} là một số nguyên.

Ví dụ: yêu cầu sau đây chỉ định ba thuộc tính tuỳ chỉnh.

$ curl -H "Content-Type: application/json" -X PUT -d \
'{
        "apiResources": [
        "/reserve/{id}**",
        "/charge/{id}**"
        ],
        "approvalType": "auto",
        "attributes": [
        {
                "name": "MINT_CUSTOM_ATTRIBUTE_1",
                "value": "test1"
        },
        {
                "name": "MINT_CUSTOM_ATTRIBUTE_2",
                "value": "test2"
        }
 
        ],
        "name": "payment",
        "proxies": [],
        "scopes": [
                ""
        ]
}' \
"https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/payment" \
-u email:password

Ví dụ về cách thiết lập tiêu chí giao dịch thành công trong một giao dịch chính sách ghi lại

Bảng sau đây cung cấp ví dụ về các giao dịch thành công và không thành công, dựa trên biểu thức tiêu chí thành công của giao dịch và giá trị txProviderStatus được trả về bởi proxy API. txProviderStatus là biến nội bộ mà tính năng kiếm tiền sử dụng để xác định giao dịch thành công.