أنت تطّلع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
تعرِض الأقسام التالية ملف الدفع الخاص بالمؤسّسة وتوضّح كيفية إدارته باستخدام واجهة المستخدم وواجهة برمجة التطبيقات.
لمحة عن الملف الشخصي للمؤسسة
كجزء من الإعداد الأوّلي لتحقيق الربح، يُعدّ فريق ضبط Apigee Edge ملف مؤسستك الشخصي.
عليك تعديل الملف الشخصي للمؤسسة لإضافة معلومات عن مؤسستك أو تعديلها حسب الاقتضاء. على سبيل المثال، قد تحتاج إلى تعديل نوع الفوترة أو إعدادات العملة أو نموذج الضريبة.
ضبط المعلومات الأساسية عن مؤسستك، بما في ذلك:
- اسم المؤسسة وعنوانها وبلد عملها
- نوع الفوترة (دفع مسبق أو دفع عند الاستخدام أو كليهما)، كما هو موضّح في فهم نوع الفوترة
- دورة الفوترة (شهر تقويمي أو نسبة مئوية)
- العملة الأساسية
- نموذج الضريبة المستخدَم في مؤسستك
يمكنك إدارة ملف تعريف مؤسستك باستخدام واجهة المستخدم وواجهة برمجة التطبيقات، كما هو موضّح في الأقسام التالية.
استكشاف صفحة "لمحة عن المؤسسة"
انتقِل إلى صفحة "ملف المؤسسة" كما هو موضَّح أدناه.
Edge
للوصول إلى صفحة "ملف الدفع لمؤسسة" باستخدام واجهة مستخدم Edge:
- سجِّل الدخول إلى apigee.com/edge.
- اختَر النشر > تحقيق الربح > الملف الشخصي للمؤسسة في شريط التنقّل الأيمن.
تظهر صفحة "ملف المؤسسة الشخصي".
كما هو موضّح في الشكل، تتيح لك صفحة "ملف المؤسسة" إجراء ما يلي:
- عرض إعدادات الملف الشخصي الحالي للمؤسسة
- تعديل إعدادات الملف الشخصي للمؤسسة، بما في ذلك:
- الاسم والمعلومات
- الضرائب والعملة
- الأحكام والشروط، كما هو موضّح في مقالة إدارة الأحكام والشروط
Classic Edge (سحابة خاصة)
للوصول إلى صفحة "ملف الدفع لمؤسسة" باستخدام واجهة مستخدم Edge الكلاسيكية:
- سجِّل الدخول إلى
http://ms-ip:9000
، حيث يكون ms-ip هو عنوان IP أو اسم نظام أسماء النطاقات الخاص بعقدة "خادم الإدارة". - اختَر المشرف > الملف الشخصي للمؤسسة في شريط التنقّل العلوي.
تظهر صفحة "ملف المؤسسة الشخصي".
تتيح لك صفحة "الملف الشخصي للمؤسسة" إجراء ما يلي:
- عرض إعدادات الملف الشخصي الحالي للمؤسسة
- تعديل إعدادات الملف الشخصي للمؤسسة، بما في ذلك:
- الاسم والمعلومات
- الضرائب والعملة
- الأحكام والشروط، كما هو موضّح في مقالة إدارة الأحكام والشروط
تعديل الملف الشخصي للمؤسسة باستخدام واجهة المستخدم
لتعديل الملف الشخصي للمؤسسة باستخدام واجهة المستخدم:
- انتقِل إلى صفحة ملف المؤسسة الشخصي.
- انقر على تعديل.
- ضمن الاسم والمعلومات، عدِّل اسم المؤسسة وبلد عملها.
- ضمن الضرائب والعملة، عدِّل الحقول التالية:
الحقل الوصف نموذج الضريبة ملاحظة: لا ينطبق هذا الإجراء إلا إذا أعددت خططًا لمعدّلات مشاركة الأرباح وأردت إنشاء مستندات فوترة.
نموذج الضريبة لخطط تعرفة مشاركة الأرباح التي تحدّد نوع مستندات الفوترة المطلوبة.
تشمل القيم الصالحة ما يلي:
- تم الإفصاح عنه: يتصرّف مقدّم واجهة برمجة التطبيقات كوكيل مُعلَن عنه للمطوّر. يتم تصعيد إجمالي الأرباح (بما في ذلك ضرائب المبيعات) التي يتم جمعها من المستخدم النهائي إلى المطوِّر. يتم تحصيل عمولة مقدّم واجهة برمجة التطبيقات من المطوّر في شكل فاتورة عمولة. لا يتعامل مقدّم واجهة برمجة التطبيقات مع ضريبة المبيعات التي يتم تحصيلها من المستخدم النهائي، وتقع على عاتق المطوّر مهمة الإبلاغ عن ضريبة المبيعات.
- غير مُعلَن عنه: يتصرّف موفِّر واجهة برمجة التطبيقات كوكيل غير مُعلَن عنه للمطوّر، ويخصم الضريبة التي يتم جمعها من المستخدمين النهائيين ويدفعها إلى الهيئات الضريبية المحلية. يُرسِل المطوّر فاتورة لمقدّم واجهة برمجة التطبيقات مقابل حصة صافي الأرباح المستحقة للمطوّر (بعد خصم ضرائب المبيعات وعمولة مقدّم واجهة برمجة التطبيقات ).
- المختلط: يتصرّف مقدّم واجهة برمجة التطبيقات كوكيل مُعلَن عنه للمطوّر. ومع ذلك، يدفع مقدّم واجهة برمجة التطبيقات ضريبة المبيعات التي يتم تحصيلها من المشتركين إلى سلطات الضرائب المحلية بالنيابة عن المطوّر. يحوّل موفِّر واجهة برمجة التطبيقات الأرباح المتبقية إلى المطوّر، ثم يُرسِل فواتير تتضمن رسوم العمولة.
العملة العملات التي تتيحها مؤسستك بالنسبة إلى خطط مشاركة الأرباح وبطاقات الأسعار والخطط التي تتضمّن رسومًا فقط، يتم استخدام العملة التلقائية لخطتك. عند إنشاء بطاقة تعرفات أو خطة رسوم فقط، يمكنك تغيير العملة التي تريد استخدامها من خلال الاختيار من قائمة العملات المتوافقة. يمكنك اختياريًا تحديد الحد الأدنى لمبلغ الرصيد الإضافي الذي يمكن لمطوّري التطبيقات إضافته إلى رصيد حساباتهم المدفوعة مسبقًا لكل عملة.
لإضافة عملة:
- انقر على إضافة عملة.
- اختَر عملة من القائمة المنسدلة في الحقل Currency (العملة).
- يمكنك اختياريًا ضبط الحد الأدنى للمبلغ الذي يمكن لمطوّري التطبيقات إضافته إلى رصيد حساباتهم المدفوعة مسبقًا بالعملة المحدّدة في حقل الحد الأدنى لإضافة رصيد.
- انقر على إضافة.
- يمكنك ضبطها كعملة تلقائية، إذا أردت، من خلال النقر على زر الاختيار المرتبط بها.
- كرِّر الخطوات لإضافة عملات إضافية.
لحذف عملة، حرِّك مؤشر الماوس فوق العملة التي تريد حذفها وانقر على .
- إدارة الأحكام والشروط، كما هو موضّح في مقالة إدارة الأحكام والشروط باستخدام واجهة المستخدم
- انقر على حفظ.
إدارة الملف الشخصي للمؤسسة باستخدام واجهة برمجة التطبيقات
يمكنك إدارة الملف الشخصي للمؤسسة باستخدام واجهة برمجة التطبيقات، كما هو موضَّح في الأقسام التالية.
عرض الملف الشخصي للمؤسسة باستخدام واجهة برمجة التطبيقات
يمكنك عرض ملف مؤسستك التجاري من خلال إرسال طلب GET إلى /mint/organizations/{org_name}
. على سبيل المثال:
curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Accept: application/json" \ -u email:password
في ما يلي مثال على الردّ. لمزيد من المعلومات حول الخيارات المعروضة، يُرجى الاطّلاع على خصائص ضبط الملف الشخصي للمؤسسة في واجهة برمجة التطبيقات.
{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "test-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "{org_name}" "issueNettingStmt" : false, "logoUrl" : " https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "myorg", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : true, "status" : "ACTIVE", "supportedBillingType" : "PREPAID", "taxModel" : "UNDISCLOSED", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }
تعديل الملف الشخصي للمؤسسة باستخدام واجهة برمجة التطبيقات
عدِّل الملف الشخصي للمؤسسة من خلال إرسال طلب PUT إلى
/mint/organizations/{org_name}
. عند تعديل ملف تعريف المؤسسة، عليك تحديد جميع
سمات ملف تعريف المؤسسة، وليس السمات التي تعدّلها فقط.
لتعديل العملة التلقائية للمؤسسة، اضبط قيمة currency
على
رمز العملة ISO 4217
للعملة المتوافقة التي تريد ضبطها كعملة تلقائية.
على سبيل المثال، تعمل طلب البيانات التالي من واجهة برمجة التطبيقات على تعديل currency
إلى دولار أمريكي وإعداد HYBRID
لنموذج الضريبة (يتم تمييز الحقول المعدَّلة في المثال). لمزيد من
المعلومات حول الخيارات المعروضة، يُرجى الاطّلاع على إعدادات الملف الشخصي للمؤسسة
وخصائص واجهة برمجة التطبيقات.
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address”, "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
ضبط أنواع الفوترة المدفوعة مسبقًا والمدفوعة بعد انتهاء الخدمة باستخدام واجهة برمجة التطبيقات
يمكن ضبط حسابات المطوّرين لاستخدام أنواع الفوترة التالية: الفوترة المدفوعة مسبقًا أو الفوترة بعد الدفع أو كليهما.
باستخدام الحسابات المدفوعة مسبقًا، يدفع المطوّرون مقدّمًا مقابل استخدام واجهات برمجة التطبيقات. ويتم خصم الأموال من رصيد المطوّر المدفوع مسبقًا والذي يتم الاحتفاظ به من خلال مقدّم خدمة مدمج لمعالجة المعاملات. على المطوّر الاحتفاظ برصيد مسبق الدفع كافٍ لشراء واجهات برمجة التطبيقات.
في الحسابات المدفوعة بعد انتهاء الشهر، يتم تحصيل الرسوم من المطوّرين شهريًا (من خلال فاتورة) في نهاية الشهر. يدفع المطوّر مقابل استخدام منتجات واجهة برمجة التطبيقات استنادًا إلى بنود الدفع التي تحدّدها الخطط المضمّنة في الفاتورة.
لضبط أنواع الفوترة المدفوعة مسبقًا والمدفوعة بعد انتهاء الخدمة لمؤسستك، اضبط السمة supportedBillingType
على إحدى
القيم التالية للإشارة إلى أنواع الفوترة الصالحة: PREPAID
أو POSTPAID
أو BOTH
. في حال ضبط القيمة على BOTH
،
ستكون القيمة التلقائية هي PREPAID
عند إضافة مطوّر تطبيقات أو شركة. في هذه الحالة، يمكنك تحديد نوع الفوترة صراحةً لشركة أو مطوّر تطبيقات باستخدام واجهة برمجة التطبيقات، كما هو موضّح في
إدارة الشركات ومطوّري التطبيقات.
على سبيل المثال:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
ضبط دورة الفوترة باستخدام واجهة برمجة التطبيقات
لضبط دورة الفوترة لمؤسستك، اضبط السمة billingCycle
على إحدى القيم التالية:
PRORATED
: تستند الفوترة إلى عدد الأيام التي يتم فيها استخدام منتج واجهة برمجة التطبيقات في شهر تقويمي.CALENDAR_MONTH
: تتم الفوترة شهريًا.
على سبيل المثال:
curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}" \ -H "Content-Type: application/json" \ -d '{ "address" : [ { "address1" : "Test address", "city" : "Test City", "country" : "US", "id" : "corp-address", "isPrimary" : true, "state" : "CA", "zip" : "54321" } ], "approveTrusted" : false, "approveUntrusted" : false, "billingCycle" : "CALENDAR_MONTH", "country" : "US", "currency" : "USD", "description" : "Test organization", "hasBillingAdjustment" : true, "hasBroker" : false, "hasSelfBilling" : false, "hasSeparateInvoiceForProduct" : false, "id" : "myorg", "issueNettingStmt" : false, "logoUrl" : "https://dl.dropboxusercontent.com/u/48279818/LOGOS/testorg.jpeg", "name" : "{org_name}", "nettingStmtPerCurrency" : false, "regNo" : "RegNo-1234-myorg", "selfBillingAsExchOrg" : false, "selfBillingForAllDev" : false, "separateInvoiceForFees" : false, "status" : "ACTIVE", "supportedBillingType" : "POSTPAID", "taxModel" : "HYBRID", "taxRegNo" : "TaxRegNo-1234-myorg", "timezone" : "UTC" }' \ -u email:password
سمات إعدادات الملف الشخصي للمؤسسة لواجهة برمجة التطبيقات
يتيح لك ملف المؤسسة ضبط خصائص الإعدادات التالية باستخدام واجهة برمجة التطبيقات.
الاسم | الوصف | تلقائي | مطلوب؟ |
---|---|---|---|
address |
عنوان المؤسسة، والذي يمكن أن يتضمّن عنوان الشارع والمدينة والولاية والرمز البريدي والبلد، بالإضافة إلى إشارة إلى ما إذا كان هذا هو العنوان الأساسي للمؤسسة. |
لا ينطبق | لا |
approveTrusted |
لا يتم استخدام هذا العلامة. |
لا ينطبق | لا |
approveUntrusted |
لا يتم استخدام هذا العلامة. |
لا ينطبق | لا |
billingCycle |
مدة دورة الفوترة يمكن أن تكون القيمة إحدى القيم التالية:
راجِع مقالة ضبط دورة الفوترة باستخدام واجهة برمجة التطبيقات. |
لا ينطبق | نعم |
country |
رمز ISO 3166-2 للبلد الذي تعمل فيه المؤسسة، مثل BR للبرازيل |
لا ينطبق | نعم |
currency |
رمز ISO 4217 للعملة "الأساسية" أو العملة المحاسبية التي تستخدمها المؤسسة (مثل USD للدولار الأمريكي). بالنسبة إلى خطط مشاركة الأرباح: يتم استخدام العملة المحدّدة لخطتك. بالنسبة إلى خطط الأسعار (نموذج تحصيل الرسوم): ينطبق الإجراء نفسه على خطط مشاركة الأرباح. ومع ذلك، يمكنك تغيير إعداد العملة إلى أي عملة متوافقة مع المؤسسة. بالنسبة إلى الخطط التي تتضمّن رسومًا فقط: يمكنك تغيير إعداد العملة إلى أي عملة متوافقة مع المؤسسة. |
لا ينطبق | نعم |
description |
وصف موجز للمؤسسة |
لا ينطبق | لا |
hasBillingAdjustment |
علامة تحدّد ما إذا كانت التعديلات مفعّلة في حال تفعيل هذه الميزة، يمكنك إجراء تعديلات على تفاصيل الزيارات التي تسجّلها "خدمات واجهة برمجة التطبيقات" لمنتجاتك المستندة إلى واجهة برمجة التطبيقات. ويمكن أن تكون قيمة أيًا مما يلي:
|
لا ينطبق | لا |
hasBroker |
علامة تحدّد ما إذا كانت الأرباح تستند إلى القيمة الصافية. يمكن أن تكون القيمة أيًّا مما يلي:
|
لا ينطبق | لا |
hasSelfBilling |
علامة توجّه ميزة تحقيق الربح لإنشاء فاتورة ذاتية الفوترة بدلاً من بيان مشاركة الأرباح. الفاتورة الذاتية الفوترة هي مستند مالي يوضّح بالتفصيل المبلغ المستحقّ على مطوّر التطبيق. وتعمل هذه الفاتورة كمستند يُرسَل إلى مقدّم واجهة برمجة التطبيقات نيابةً عن مطوّر التطبيق. يمكن أن تكون القيمة أيًّا ممّا يلي:
|
لا ينطبق | لا |
hasSeparateInvoiceForProduct |
علامة تحدّد ما إذا كان سيتم إنشاء فاتورة منفصلة لكل منتج من منتجات واجهة برمجة التطبيقات. يمكن أن تكون قيمة أيًّا ممّا يلي:
|
لا ينطبق | لا |
id |
رقم تعريف المؤسسة. |
لا ينطبق | لا |
issueNettingStmt |
علامة تحدِّد ما إذا كان سيتم إنشاء بيان تسوية عند إنشاء مستندات الفوترة. يمكن أن تكون القيمة أيًّا ممّا يلي:
|
لا ينطبق | لا |
logoUrl |
عنوان URL لشعار المؤسسة. |
لا ينطبق | لا |
name |
اسم المؤسسة |
لا ينطبق | نعم |
netPaymentAdviceNote |
ملاحظة بشأن صافي دفعة |
لا ينطبق | لا |
nettingStmtPerCurrency |
علامة تحدِّد ما إذا كان سيتم إنشاء بيان تسوية منفصل لكل عملة مستخدَمة. يمكن أن تكون القيمة أيًّا ممّا يلي:
|
لا ينطبق | لا |
regNo |
رقم تسجيل المؤسسة يظهر الرقم الذي تُدخله لهذا الموقع في أسفل مستندات الفوترة. |
لا ينطبق | لا |
selfBillingAsExchOrg |
في حال تفعيل فواتير الفوترة الذاتية، يشير ذلك إلى ما إذا كان مفعّلاً لمبادلة المؤسسات. يمكن أن تكون القيمة أيًّا ممّا يلي:
|
لا ينطبق | لا |
selfBillingForAllDev |
في حال تفعيل فواتير الفوترة الذاتية، يشير ذلك إلى ما إذا كان مفعّلاً لجميع مطوّري التطبيقات. لا يتم تلقائيًا إنشاء فواتير الفوترة الذاتية إلا لمطوّري التطبيقات الذين وقعوا اتفاقية مع مقدّم واجهة برمجة التطبيقات. يمكن أن تكون القيمة أيًّا ممّا يلي:
|
خطأ | لا |
separateInvoiceForFees |
علامة تحدّد ما إذا كان يتم نشر فاتورة منفصلة للرسوم يمكن أن تكون القيمة أيًّا ممّا يلي:
|
خطأ | نعم |
status |
حالة المؤسسة تشمل القيم الصالحة ما يلي:
|
لا ينطبق | لا |
supportedBillingType |
نموذج دفع المطوّر المستخدَم للفوترة يمكن أن تكون القيمة إحدى القيم التالية:
راجِع مقالة ضبط أنواع الفوترة المدفوعة مسبقًا والمدفوعة بعد انتهاء الخدمة باستخدام واجهة برمجة التطبيقات. |
PREPAID | نعم |
taxModel |
ملاحظة: لا ينطبق هذا الإجراء إلا إذا أعددت خططًا لمعدّلات مشاركة الأرباح وأردت إنشاء مستندات فوترة. نموذج الضريبة لخطط تعرفة مشاركة الأرباح التي تحدّد نوع مستندات الفوترة المطلوبة. تشمل القيم الصالحة ما يلي:
|
لا ينطبق | نعم |
taxNexus |
البلد الذي تم تسجيل المؤسسة فيه لأغراض ضريبية. |
لا ينطبق | لا |
taxRegNo |
رقم تسجيل المؤسسة الضريبي أو رقم تسجيل ضريبة القيمة المضافة (VAT)، إن وُجد هذه السمة اختيارية لأنّ رقم التسجيل الضريبي أو رقم تسجيل ضريبة القيمة المضافة لا ينطبقان في بعض البلدان. يظهر الرقم الذي تُدخله لهذه المَعلمة في أسفل مستندات الفوترة. |
لا ينطبق | لا |
transactionRelayURL |
عنوان URL لنظام آخر يمكن إعادة توجيه المعاملات إليه، مثل مستودع data warehouse |
لا ينطبق | لا |
timezone |
معرّف المنطقة الزمنية لعمليات المؤسسة، مثل أمريكا/نيويورك أو أوروبا/باريس يمكن أيضًا استخدام الاختصارات للمناطق الزمنية، مثل التوقيت العالمي المنسق أو التوقيت الرسمي الشرقي (EST) أو التوقيت المركزي الأوروبي (CET). |
لا ينطبق | نعم |
إلغاء إعدادات ملف تحقيق الربح لشركة أو مطوّر تطبيقات
يمكنك إلغاء إعدادات الملف الشخصي لتحقيق الربح لشركة أو مطوّر تطبيقات باستخدام واجهة المستخدم أو واجهة برمجة التطبيقات، كما هو موضّح في الأقسام التالية: