ضبط سياسة تسجيل المعاملات

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

يمكنك ضبط سياسات تسجيل المعاملات لكل منتج من منتجات واجهة برمجة التطبيقات في حزمة منتجات واجهة برمجة التطبيقات، كما هو موضَّح في الأقسام التالية.

مقدمة

تتيح سياسة تسجيل المعاملات تحقيق الربح لتسجيل مَعلمات المعاملات السمات المخصصة. تحتاج ميزة تحقيق الربح إلى هذه المعلومات لمعالجة عملية تحقيق الربح. مثل تطبيق خطط الأسعار

على سبيل المثال، في حال إعداد خطة أسعار لحصة الأرباح، يمكن أن تكون النسبة المئوية تتم مشاركة الأرباح الناتجة عن كل معاملة تشمل منتج واجهة برمجة التطبيقات الذي يتم تحقيق الربح منه مع مطوّر التطبيق الذي أصدر الطلب تعتمد حصة الأرباح على صافي المبلغ أو إجمالي سعر المعاملة (ما عليك سوى تحديد السعر)، أي نسبة مئوية من السعر الإجمالي أو الصافي لكل معاملة لتحديد حصة الأرباح. لهذا السبب، يجب تحقيق الربح لمعرفة السعر الإجمالي أو الصافي للمعاملة، حسب الاقتضاء. يحصل على السعر الإجمالي أو الصافي من الإعدادات التي تحدّدها في سياسة تسجيل المعاملات

في حال إعداد بطاقة سعر حيث يمكنك تحصيل رسوم من المطوّر مقابل كل معاملة، فيمكنك تحديد سعر الخطة تستند إلى سمة مخصّصة، مثل عدد وحدات البايت المنقولة في معاملة. تحتاج ميزة تحقيق الربح إلى التعرّف على السمة المخصّصة ومكان العثور عليها. لذلك تحتاج إلى تحديد السمة المخصّصة في سياسة تسجيل المعاملات.

بالإضافة إلى تحديد سمات المعاملات في سياسة تسجيل المعاملات، يمكنك تحديد معايير نجاح المعاملات لتحديد توقيت نجاح المعاملة (على أغراض الشحن). للحصول على أمثلة على إعداد معايير نجاح المعاملات، راجِع المقالة أمثلة على إعداد معايير نجاح المعاملات في تسجيل المعاملات. . يمكنك أيضًا تحديد سمات مخصّصة لمنتج واجهة برمجة التطبيقات (الذي تعتمد عليه السعر الأساسي). رسوم الخطة).

ضبط سياسة تسجيل المعاملات

يمكنك الوصول إلى صفحة حِزم المنتجات، كما هو موضَّح أدناه.

ضبط سمات المعاملات

في القسم سمات المعاملات، حدِّد المعايير التي تشير إلى معاملة تحقيق الربح بنجاح.

1. في الحقل معايير نجاح العملية، حدِّد التعبير استنادًا إلى قيمة سمة "الحالة". (على النحو الموضَّح في ما يلي) لتحديد وقت نجاح المعاملة (لأغراض تحصيل الرسوم). المعاملات التي لم تتم بنجاح (أي أنها لا تستوفي المعايير في التعبير)، ولكن لا يتم تطبيق خطط الأسعار عليها. على سبيل المثال:

   txProviderStatus == 'OK'

2. تحتوي السمة Status على القيمة التي يستخدمها التعبير الذي تم ضبطه في الحقل معايير نجاح المعاملة اضبط السمة الحالة من خلال تحديد الحقول التالية:

   الحقل	الوصف
   مورد واجهة برمجة التطبيقات	أنماط معرف الموارد المنتظم (URI) المحدّدة في منتج واجهة برمجة التطبيقات والتي سيتم استخدامها في تحديد المعاملات التي يتم تحقيق الربح منها
   الموقع الجغرافي للردّ	تمثّل هذه السمة مكان الاستجابة حيث يتم تحديد السمة. وتشمل القيم الصالحة: متغيّر التدفق والعنوان ونص JSON ونص XML.
   القيمة	قيمة الردّ لتحديد أكثر من قيمة واحدة، انقر على + إضافة x (على سبيل المثال، + إضافة متغيّر تدفق).

3. لضبط سمات المعاملات الاختيارية، فعِّل خيار استخدام السمات الاختيارية واضبط الخيار. لأي من سمات المعاملات المحددة في الجدول التالي.

   السمة	الوصف
   السعر الإجمالي	لا تنطبق هذه السمة إلا على خطط الأسعار التي تستخدم نموذج حصة الأرباح. وبالنسبة إلى خطط الأسعار هذه، يكون "السعر الإجمالي" أو "السعر الصافي" إلزاميًا. تأكد من أن ويتم التعبير عن القيمة الرقمية كنوع سلسلة. السعر الإجمالي للمعاملة. بالنسبة عليك تسجيل سمة السعر الإجمالي أو صافي السعر . تعتمد السمة المطلوبة على أساس حصة الأرباح. بالنسبة يمكنك مثلاً إعداد خطة لحصة الأرباح على أساس السعر الإجمالي معاملة. وفي هذه الحالة، يجب ملء حقل "السعر الإجمالي".
   السعر الصافي	لا تنطبق هذه السمة إلا على خطط الأسعار التي تستخدم نموذج حصة الأرباح. يكون "السعر الإجمالي" أو "صافي السعر" إلزاميًا في خطط الأسعار هذه. تأكد من أن ويتم التعبير عن القيمة الرقمية كنوع سلسلة. السعر الصافي للمعاملة. بالنسبة في خطط حصة الأرباح، يجب تسجيل حقل "صافي السعر" أو . يعتمد الحقل المطلوب على أساس حصة الأرباح. على سبيل المثال: يمكنك إعداد خطة لحصة الأرباح استنادًا إلى السعر الصافي للمعاملة. وفي هذه الحالة، يكون حقل "السعر الصافي" مطلوبًا.
   العملة	هذه السمة مطلوبة لخطط الأسعار التي تستخدِم نموذج حصة الأرباح. نوع العملة التي تنطبق على المعاملة.
   رمز الخطأ	رمز الخطأ المرتبط بالمعاملة يوفر المزيد من معلومات حول معاملة فاشلة.
   وصف العنصر	وصف العملية
   الضريبة	هذه السمة مخصّصة لنماذج مشاركة الأرباح فقط، وذلك فقط في حال: تسجيل مبلغ الضريبة في طلبات البيانات من واجهة برمجة التطبيقات. التأكد من التعبير عن القيمة الرقمية كنوع سلسلة. مبلغ الضريبة على عملية الشراء السعر الصافي بالإضافة إلى الضريبة = السعر الإجمالي.

على سبيل المثال، من خلال ضبط القيم التالية، تحصل ميزة تحقيق الربح على قيمة متغيّر التدفق من استجابة الرسالة في متغيّر يسمى response.reason.phrase. إذا كانت القيمة على ما يرام، تكون سياسة التحقّق من الحدود القصوى لتحقيق الربح مرفقًا بطلب ProxyEndpoint لواجهة برمجة التطبيقات، فستحتسب ميزة تحقيق الربح هذه المعاملة كمعاملة.

إعداد السمات المخصّصة

في قسم السمات المخصصة، يمكنك تحديد السمات المخصصة لتضمينها في سياسة تسجيل المعاملات على سبيل المثال، في حال إعداد خطة بطاقة أسعار، تحصّل من المطوّر قيمة كل يمكنك ضبط سعر الخطة استنادًا إلى سمة مخصّصة مثل عدد وحدات البايت المنقولة في معاملة. يجب بعد ذلك تضمين هذه السمة المخصّصة في سياسة تسجيل المعاملات

يتم تخزين كل سمة من هذه السمات في سجلّ العمليات، الذي يمكنك الاستعلام عنه. وهي أيضًا العرض عند إنشاء خطة أسعار (بحيث يمكنك اختيار سمة واحدة أو أكثر من هذه السمات في لتحديد سعر الخطة).

يمكنك تضمين سمات مخصّصة محدّدة في سياسة تسجيل المعاملات في أرباحك. التقارير الموجزة، كما هو موضح في تضمين معاملات مخصّصة السمات في تقارير ملخّص الأرباح

لضبط السمات المخصّصة، فعِّل خيار استخدام السمات المخصّصة وحدِّد وما يصل إلى 10 سمات مخصصة. بالنسبة إلى كلّ سمة مخصّصة تُدرجها في سياسة تسجيل المعاملات: عليك تحديد المعلومات التالية.

ربط الموارد باستخدام معرِّف معاملة فريد

تكون بعض المعاملات بسيطة، وتتضمّن استدعاء واجهة برمجة التطبيقات لمورد واحد. ومع ذلك، فإن عناوين URL الأخرى يمكن أن تكون المعاملات أكثر تعقيدًا. على سبيل المثال، لنفترض أنّك أجريت معاملةً لشراء منتج داخل التطبيق يتضمن منتج ما في أحد تطبيقات الألعاب على الأجهزة المحمولة مكالمات متعددة للموارد:

• يشير هذا المصطلح إلى طلب إلى واجهة برمجة تطبيقات للحجز للتأكّد من حصول مستخدم الدفع المُسبَق على رصيد كافٍ لشراء الحزمة. المنتج ويخصص ("احتياطي") الأموال لعملية الشراء.
• استدعاء لواجهة برمجة تطبيقات تحصيل الرسوم التي تخصم الأموال من حساب المستخدم المدفوع مسبقًا.

لمعالجة المعاملة بأكملها، يحتاج تحقيق الربح إلى طريقة لربط المورد الأول ( الاتصال والاستجابة إلى واجهة برمجة تطبيقات الحجز والاستجابة لها) باستخدام المورد الثاني (الاتصال والاستجابة إلى ومن واجهة برمجة تطبيقات الرسوم). للقيام بذلك، فإنه يعتمد على المعلومات التي تحددها في قسم ربط الموارد بمعرِّف المعاملة الفريد.

لضبط السمات المخصّصة، فعِّل زر الإيقاف/التفعيل استخدام معرّفات المعاملات الفريدة والربط. للمعاملات. بالنسبة إلى كل معاملة، عليك تحديد مورد وموقع الاستجابة وقيمة سمة المرتبطة بالقيم المقابلة في المعاملات.

على سبيل المثال، لنفترض أن طلب بيانات الحجز من واجهة برمجة التطبيقات وطلب البيانات من واجهة برمجة التطبيقات مرتبطان على النحو التالي: يتجاوب هذا الحقل المسمى session_id في عنوان الاستجابة من واجهة برمجة تطبيقات الحجز مع عنوان استجابة باسم reference_id من واجهة برمجة تطبيقات الرسوم. في هذه الحالة، يمكنك تعيين الإدخالات في القسم "Link resources" مع معرّف معاملة فريد على النحو التالي:

إعداد عمليات ردّ الأموال

في قسم عمليات ردّ الأموال، يمكنك تحديد السمات التي استخدام ميزة تحقيق الربح لمعالجة عمليات ردّ الأموال.

على سبيل المثال، لنفترض أن المستخدم اشترى منتجًا من تطبيق للأجهزة الجوّالة يستخدم واجهات برمجة التطبيقات التي تحقّق الربح. يتم تحقيق الربح من المعاملة استنادًا إلى القيمة المشتركة وخطة الإيرادات. ومع ذلك، لنفترض أن المستخدم غير راضٍ عن المنتج ويريد إرجاعه. إذا كانت باستخدام طلب إلى واجهة برمجة التطبيقات لردّ الأموال، فإن تحقيق الربح تعديلات تحقيق الربح اللازمة ويتم ذلك بناءً على المعلومات التي تحددها في قسم عمليات ردّ الأموال في سياسة تسجيل المعاملات

لضبط عمليات ردّ الأموال، فعِّل خيار استخدام سمات ردّ الأموال وحدِّد تفاصيل عملية ردّ الأموال:

1. يجب تحديد معايير ردّ الأموال من خلال تحديد الحقول التالية:

   الحقل	الوصف
   الموقع الجغرافي للردّ	مرجع معاملة ردّ الأموال إذا كان منتج واجهة برمجة التطبيقات يوفر موارد متعددة، يمكنك فقط تحديد المورد الذي يُجري عملية رد الأموال.
   معايير نجاح عمليات ردّ الأموال	تعبير يستند إلى قيمة سمة الحالة (الموضّحة بعد ذلك) لتحديد وقت نجاح معاملة ردّ الأموال (لتحصيل الرسوم) ). معاملات رد الأموال غير الناجحة (أي أنها لا تستوفي المعايير الواردة في التعبير العادي)، ولكن لا يتم تطبيق خطط الأسعار عليها. على سبيل المثال: txProviderStatus == 'OK'

2. اضبط السمة الحالة من خلال تحديد الحقول التالية:

   الحقل	الوصف
   الموقع الجغرافي للردّ	تمثّل هذه السمة مكان الاستجابة حيث يتم تحديد السمة. وتشمل القيم الصالحة: متغيّر التدفق والعنوان ونص JSON ونص XML.
   القيمة	قيمة الردّ لتحديد أكثر من قيمة واحدة، انقر على + إضافة x (على سبيل المثال، + إضافة متغيّر تدفق).

3. اضبط السمة Parent ID من خلال تحديد الحقول التالية:

   الحقل	الوصف
   الموقع الجغرافي للردّ	تمثّل هذه السمة مكان الاستجابة حيث يتم تحديد السمة. وتشمل القيم الصالحة: متغيّر التدفق والعنوان ونص JSON ونص XML.
   القيمة	رقم تعريف المعاملة التي تمت معالجة عملية ردّ الأموال لها. على سبيل المثال، إذا اشترى أحد المستخدمين منتجًا ثم طلب استرداد الأموال، فإن معرِّف المعاملة الرئيسية هو معرّف معاملة الشراء. لتحديد أكثر من قيمة واحدة، انقر على + إضافة x (على سبيل المثال، + إضافة متغيّر تدفق).

4. لضبط السمات الاختيارية لردّ الأموال، فعِّل خيار استخدام سمات ردّ الأموال الاختيارية واضبط ذلك. السمات. سمات رد الأموال الاختيارية هي نفسها سمات المعاملات الاختيارية، كما هو موضح في إعداد سمات المعاملات

إدارة سياسات تسجيل المعاملات باستخدام واجهة برمجة التطبيقات

توضّح الأقسام التالية كيفية إدارة سياسات تسجيل المعاملات باستخدام واجهة برمجة التطبيقات.

إنشاء سياسة تسجيل المعاملات باستخدام واجهة برمجة التطبيقات

عليك تحديد سياسة تسجيل المعاملات كسمة لمنتج واجهة برمجة التطبيقات. تحدد قيمة يحدد ما يلي:

• لاحقة معرّف الموارد المنتظم (URI) لمورد المنتج الذي تنطبق عليه سياسة تسجيل المعاملات مرفق. تتضمن اللاحقة متغير نمط تم تضمينه بين أقواس معقوفة. النمط يتم تقييم المتغيّر باستخدام "خدمات واجهة برمجة التطبيقات" في وقت التشغيل. على سبيل المثال، لاحقة URI التالية يتضمن متغير النمط {id}.

  /reserve/{id}**
  

  في هذه الحالة، تقيّم خدمات واجهة برمجة التطبيقات لاحقة معرف الموارد المنتظم (URI) للمورد على أنه /reserve متبوعًا بأي دليل فرعي يبدأ برقم تعريف محدّد من خلال واجهة برمجة التطبيقات المستخدم.

• المورد في الردّ الذي تم إرفاقه به يمكن أن يحتوي منتج واجهة برمجة التطبيقات على العديد من ويمكن أن يتضمن كل مورد سياسة تسجيل معاملات مرفقة بردّ من هذا المورد.
• يشير هذا المصطلح إلى سياسة متغيّرات تتيح لاستخراج المحتوى استنادًا إلى سياسة تسجيل المعاملات. من رسالة رد لمعلمات المعاملات التي تريد تسجيلها.

يمكنك إضافة سمة سياسة تسجيل المعاملات إلى منتج واجهة برمجة التطبيقات من خلال إصدار طلب PUT. إلى واجهة برمجة تطبيقات الإدارة https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id} (وليس إلى واجهة برمجة تطبيقات تحقيق الربح)

تحديد معايير نجاح المعاملات باستخدام واجهة برمجة التطبيقات

يمكنك تحديد معايير نجاح المعاملات لتحديد حالات نجاح المعاملة. (لأغراض الشحن). المعاملات غير الناجحة (أي أنها تستوفي المعايير في التعبير)، ولكن لا يتم تطبيق خطط الأسعار عليها. للحصول على أمثلة لإعداد معايير نجاح المعاملات، راجع أمثلة على ضبط معايير نجاح المعاملات في سياسة تسجيل المعاملات

عليك تحديد معايير نجاح المعاملات كسمة لمنتج في واجهة برمجة التطبيقات. إجراء ذلك من خلال إصدار طلب PUT إلى واجهة برمجة تطبيقات الإدارة https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id} (وليس على واجهة برمجة تطبيقات تحقيق الربح)

على سبيل المثال، في الطلب التالي، تكون المعاملة ناجحة إذا كانت قيمة txProviderStatus هو success (معايير نجاح المعاملة ذات الصلة المواصفات).

$ 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

تحديد السمات المخصّصة باستخدام واجهة برمجة التطبيقات

يمكنك تحديد سمات مخصّصة لمنتج واجهة برمجة التطبيقات الذي تحصّل رسوم خطة السعر الأساسي عليه. بالنسبة إذا أعددت خطة بطاقة أسعار، وتقوم بتحصيل رسوم من المطوّر مقابل كل معاملة، يجب يمكنها ضبط معدل الخطة استنادًا إلى سمة مخصّصة مثل عدد وحدات البايت المنقولة في معاملة. عند إنشاء خطة أسعار، يمكنك تحديد سمة مخصصة واحدة أو أكثر على لتحديد سعر الخطة. ومع ذلك، يمكن أن يتضمن أي منتج محدد في خطة أسعار سمة مخصصة واحدة تستند عليها سعر الخطة.

يمكنك تحديد السمات المخصّصة كسمات لمنتج واجهة برمجة التطبيقات. ويمكنك إجراء ذلك من خلال إصدار PUT. طلب لواجهة برمجة تطبيقات الإدارة https://api.enterprise.apigee.com/v1/organizations/{org_name}/apiproducts/{apiproduct_Id} (وليس على واجهة برمجة تطبيقات تحقيق الربح)

لكل سمة مخصّصة تضيفها إلى منتج من منتجات واجهة برمجة التطبيقات، يجب تحديد اسم . يجب أن يكون الاسم بالتنسيق MINT_CUSTOM_ATTRIBUTE_{num}، حيث {num} هو عدد صحيح.

على سبيل المثال، يحدد الطلب التالي ثلاث سمات مخصصة.

$ 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

أمثلة على إعداد معايير نجاح المعاملات في معاملة سياسة التسجيل

يقدم الجدول التالي أمثلة للمعاملات الناجحة وغير الناجحة، استنادًا إلى تعبير معايير نجاح المعاملة وقيمة txProviderStatus التي تم عرضها بواسطة الخادم الوكيل لواجهة برمجة التطبيقات. txProviderStatus هو المتغيّر الداخلي الذي تستخدمه ميزة تحقيق الربح. لتحديد مدى نجاح المعاملة.