أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى
مستندات Apigee X. info
توضّح الأقسام التالية ملف المؤسسة وتصف كيفية إدارته باستخدام واجهة المستخدم وواجهة برمجة التطبيقات.
لمحة عن الملف الشخصي للمؤسسة
كجزء من عملية الإعداد الأولي لتحقيق الربح، يضبط فريق إعداد Apigee Edge ملف مؤسستك.
عليك تعديل ملف المؤسسة لإضافة معلومات عن مؤسستك أو تعديلها، حسب الاقتضاء. على سبيل المثال، قد تحتاج إلى تعديل نوع الفوترة أو إعدادات العملة أو النموذج الضريبي.
اضبط المعلومات الأساسية عن مؤسستك، بما في ذلك:
- اسم المؤسسة وعنوانها وبلد التشغيل
- نوع الفوترة (الدفع المسبق أو الدفع عند الاستخدام أو كليهما)، كما هو موضّح في مقالة التعرّف على نوع الفوترة
- دورة الفوترة (نسبية أو شهر تقويمي)
- العملة الأساسية
- النموذج الضريبي الذي تستخدمه مؤسستك
يمكنك إدارة الملف التجاري لمؤسستك باستخدام واجهة المستخدم وواجهة برمجة التطبيقات، كما هو موضّح في الأقسام التالية.
استكشاف صفحة الملف الشخصي للمؤسسة
انتقِل إلى صفحة "الملف التجاري للمؤسسة"، كما هو موضّح أدناه.
Edge
للوصول إلى صفحة "الملف التجاري للمؤسسة" باستخدام واجهة مستخدم Edge:
- سجِّل الدخول إلى apigee.com/edge.
- انقر على نشر > تحقيق الربح > الملف التجاري للمؤسسة في شريط التنقّل الأيمن.
تظهر صفحة "الملف التجاري للمؤسسة".

كما هو موضّح في الشكل، تتيح لك صفحة "الملف التعريفي للمؤسسة" إجراء ما يلي:
- عرض إعدادات ملف المؤسسة الحالي
- عدِّل إعدادات ملف المؤسسة، بما في ذلك:
- الاسم والمعلومات
- الضرائب والعملة
- الأحكام والشروط، كما هو موضّح في إدارة الأحكام والشروط
Classic Edge (Private Cloud)
للوصول إلى صفحة "الملف التجاري" باستخدام واجهة مستخدم Edge الكلاسيكية، اتّبِع الخطوات التالية:
- سجِّل الدخول إلى
http://ms-ip:9000، حيث ms-ip هو عنوان IP أو اسم نظام أسماء النطاقات لعقدة خادم الإدارة. - انقر على المشرف > الملف التعريفي للمؤسسة في شريط التنقّل العلوي.
تظهر صفحة "الملف التجاري للمؤسسة".

تتيح لك صفحة "الملف التجاري للمؤسسة" إجراء ما يلي:
- عرض إعدادات ملف المؤسسة الحالي
- عدِّل إعدادات ملف المؤسسة، بما في ذلك:
- الاسم والمعلومات
- الضرائب والعملة
- الأحكام والشروط، كما هو موضّح في إدارة الأحكام والشروط
تعديل ملف المؤسسة باستخدام واجهة المستخدم
لتعديل ملف المؤسسة باستخدام واجهة المستخدم، اتّبِع الخطوات التالية:
- انتقِل إلى صفحة الملف الشخصي للمؤسسة.
- انقر على تعديل.
- ضمن الاسم والمعلومات، عدِّل اسم المؤسسة وبلد التشغيل.
- ضمن الضرائب والعملة، عدِّل الحقول التالية:
الحقل الوصف النموذج الضريبي ملاحظة: ينطبق ذلك فقط إذا أعددت خطط معدل مشاركة الأرباح وأردت إنشاء مستندات الفوترة.
نموذج الضريبة لخطط معدل مشاركة الإيرادات التي تحدد نوع مستندات الفوترة المطلوبة
تشمل القيم الصالحة ما يلي:
- تم الإفصاح عنه: يعمل مقدّم واجهة برمجة التطبيقات كوكيل مفصح عنه للمطوّر. يتم تحويل إجمالي الإيرادات (بما في ذلك ضرائب المبيعات) التي تم تحصيلها من المستخدم النهائي إلى المطوّر. يتم تحصيل عمولة مقدّم خدمة واجهة برمجة التطبيقات من المطوّر في شكل فاتورة عمولة. لا يتعامل مقدّم واجهة برمجة التطبيقات مع ضريبة المبيعات التي يتم تحصيلها من المستخدم النهائي، ويتحمّل المطوّر مسؤولية الإبلاغ عن ضريبة المبيعات.
- غير معلن: يعمل مقدّم خدمة واجهة برمجة التطبيقات كوكيل غير معلن للمطوّر، ويخصم الضريبة المحصّلة من المستخدمين النهائيين ويدفعها إلى السلطات الضريبية المحلية. يُصدر المطوّر فواتير إلى مقدّم خدمة واجهة برمجة التطبيقات مقابل حصة صافي الأرباح المستحقة للمطوّر (بعد خصم ضريبة المبيعات وعمولة مقدّم خدمة واجهة برمجة التطبيقات).
- النوع المختلط: يعمل مقدّم واجهة برمجة التطبيقات كوكيل معلن للمطوّر. ومع ذلك، يدفع مقدّم خدمة واجهة برمجة التطبيقات ضريبة المبيعات التي يتم تحصيلها من المشتركين إلى الجهات الضريبية المحلية نيابةً عن المطوّر. يُرسل موفّر واجهة برمجة التطبيقات الإيرادات المتبقية إلى المطوّر، ثم يرسل فواتير بشأن رسوم العمولة.
العملة العملات التي تقبلها مؤسستك بالنسبة إلى خطط مشاركة الأرباح وقائمة الأسعار والرسوم فقط، يتم استخدام العملة التلقائية لخطة الأسعار. عند إنشاء بطاقة أسعار أو خطة رسوم فقط، يمكنك تغيير العملة التي تريد استخدامها من خلال الاختيار من قائمة العملات المتوافقة. يمكنك اختياريًا ضبط الحدّ الأدنى لمبلغ الرصيد الذي يمكن لمطوّري التطبيقات إضافته إلى رصيد حساباتهم المدفوعة مسبقًا لكل عملة.
لإضافة عملة، اتّبِع الخطوات التالية:
- انقر على إضافة عملة.
- اختَر عملة من القائمة المنسدلة في الحقل العملة.
- يمكنك اختياريًا ضبط الحدّ الأدنى للمبلغ الذي يمكن لمطوّري التطبيقات إضافته إلى رصيد حساب الدفع المسبق بالعملة المحدّدة في حقل الحدّ الأدنى لتعبئة الرصيد.
- انقر على إضافة.
- اضبط العملة كعملة تلقائية، إذا أردت ذلك، من خلال النقر على زر الاختيار المرتبط بها.
- كرِّر الخطوات لإضافة عملات إضافية.
لحذف عملة، ضَع مؤشر الماوس فوق العملة التي تريد حذفها وانقر على
. - إدارة الأحكام والشروط، كما هو موضّح في إدارة الأحكام والشروط باستخدام واجهة المستخدم
- انقر على حفظ.
إدارة الملف التجاري للمؤسسة باستخدام واجهة برمجة التطبيقات
يمكنك إدارة الملف التعريفي للمؤسسة باستخدام واجهة برمجة التطبيقات، كما هو موضّح في الأقسام التالية.
عرض الملف التجاري للمؤسسة باستخدام واجهة برمجة التطبيقات
يمكنك عرض الملف التجاري لمؤسستك من خلال إرسال طلب استرداد بيانات باستخدام 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 لنظام آخر يمكن نقل المعاملات إليه، مثل مستودع بيانات. |
لا ينطبق | لا |
timezone |
تمثّل هذه السمة معرّف المنطقة الزمنية لعمليات المؤسسة، مثل America/New_York أو Europe/Paris. يمكنك أيضًا استخدام اختصارات المناطق الزمنية، مثل التوقيت العالمي المنسَّق أو التوقيت الرسمي الشرقي أو توقيت وسط أوروبا. |
لا ينطبق | نعم |
تجاوز إعدادات ملف تحقيق الربح لشركة أو مطوّر تطبيقات
تجاوز إعدادات ملف تعريف تحقيق الربح لشركة أو مطوّر تطبيقات باستخدام واجهة المستخدم أو واجهة برمجة التطبيقات، كما هو موضّح في الأقسام التالية: