أنت تعرض مستندات Apigee Edge.
انتقل إلى
مستندات Apigee X. معلومات
توضِّح الأقسام التالية الملف الشخصي للمؤسسة وتصف كيفية إدارته باستخدام واجهة المستخدم وواجهة برمجة التطبيقات.
لمحة عن الملف الشخصي للمؤسسة
في إطار عملية الإعداد الأوّلي لتحقيق الربح، يعمل فريق الإعداد في Apigee Edge على إعداد الملف الشخصي لمؤسستك.
يجب تعديل الملف الشخصي للمؤسّسة لإضافة معلومات عن مؤسستك أو تعديلها حسب الحاجة. على سبيل المثال، قد تحتاج إلى تعديل نوع الفوترة أو إعدادات العملة أو نموذج الضريبة.
يمكنك ضبط المعلومات الأساسية حول مؤسستك، بما في ذلك:
- اسم المؤسسة وعنوانها وبلد العمل بها
- نوع الفوترة (الدفع المسبق أو الدفع عند الاستخدام أو كليهما)، كما هو موضّح في مقالة فهم نوع الفوترة
- دورة الفوترة (شهر مقسم أو تقويمي)
- العملة الأساسية
- النموذج الضريبي الذي تستخدمه مؤسستك
يمكنك إدارة الملف الشخصي لمؤسستك باستخدام واجهة المستخدم وواجهة برمجة التطبيقات، كما هو موضّح في. الأقسام التالية.
استكشاف صفحة "الملف الشخصي للمؤسسة"
ادخل إلى صفحة "ملف تعريف المؤسسة"، كما هو موضح أدناه.
Edge
للوصول إلى صفحة "ملف تعريف المؤسسة" باستخدام واجهة مستخدم Edge:
- سجِّل الدخول إلى apigee.com/edge.
- اختَر نشر >. تحقيق الربح > ملف المؤسسة الشخصي في شريط التنقل الأيمن.
يتم عرض صفحة "الملف الشخصي للمؤسسة".
كما هو موضح في الشكل، تتيح لك صفحة "ملف المؤسسة" إجراء ما يلي:
- عرض الإعدادات الحالية للملف الشخصي للمؤسسة
- تعديل إعدادات الملف الشخصي للمؤسسة، بما في ذلك:
- الاسم والمعلومات
- الضرائب والعملة
- الأحكام والشروط، على النحو الموضّح في إدارة الأحكام والشروط
الإصدار الكلاسيكي Edge (السحابة الإلكترونية الخاصة)
للوصول إلى صفحة "ملف تعريف المؤسسة" باستخدام واجهة مستخدم 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 للبلد للمؤسسة، مثل البرازيل في البرازيل. |
لا ينطبق | نعم |
currency |
رمز ISO 4217 "للقاعدة" أو عملة المحاسبة التي تستخدمها المؤسسة (مثل الدولار الأمريكي للولايات المتحدة) دولار). بالنسبة إلى خطط مشاركة الأرباح: يتم استخدام العملة المحدّدة في خطتك. بالنسبة إلى خطط بطاقة السعر (نموذج الشحن): ينطبق ذلك على خطط مشاركة الأرباح. ومع ذلك، يمكنك تغيير إعداد العملة إلى أي عملة معتمَدة في التنظيم. بالنسبة إلى خطط الرسوم فقط: يمكنك تغيير إعداد العملة إلى أي عملة معتمَدة في المؤسسة. |
لا ينطبق | نعم |
description |
وصف موجز للمؤسسة |
لا ينطبق | لا |
hasBillingAdjustment |
علامة تحدد ما إذا كانت التعديلات مفعّلة. إذا تم تفعيله، يمكنك إجراء تعديلات على تفاصيل عدد الزيارات التي تسجِّلها "خدمات واجهة برمجة التطبيقات" لمنتجات واجهة برمجة التطبيقات واحدة مما يلي:
|
لا ينطبق | لا |
hasBroker |
علامة تحدّد ما إذا كانت الأرباح مستندة إلى الصافي يمكن أن تكون القيمة أيًا من ما يلي:
|
لا ينطبق | لا |
hasSelfBilling |
علامة توجّه تحقيق الربح لإنشاء فاتورة فوترة ذاتية بدلاً من أرباح عبارة المشاركة. الفاتورة الذاتية الفوترة هي مستند مالي يوضح تفاصيل المبلغ وذلك بفضل مطور التطبيق. وهي بمثابة فاتورة لمزوّد واجهة برمجة التطبيقات بالنيابة عن تطبيقك. يمكن أن تكون القيمة أيًا مما يلي:
|
لا ينطبق | لا |
hasSeparateInvoiceForProduct |
علامة تحدّد ما إذا كان سيتم إنشاء فاتورة منفصلة لكل منتج من منتجات واجهة برمجة التطبيقات. تشير رسالة الأشكال البيانية واحدة مما يلي:
|
لا ينطبق | لا |
id |
معرّف المؤسسة. |
لا ينطبق | لا |
issueNettingStmt |
علامة تحدد ما إذا كان سيتم إنشاء بيان الشبكات عند إنشاء الفوترة المستندات. يمكن أن تكون القيمة أيًا مما يلي:
|
لا ينطبق | لا |
logoUrl |
تمثّل هذه السمة عنوان URL لشعار المؤسسة. |
لا ينطبق | لا |
name |
تمثّل هذه السمة اسم المؤسسة. |
لا ينطبق | نعم |
netPaymentAdviceNote |
ملاحظة حول صافي الدفع |
لا ينطبق | لا |
nettingStmtPerCurrency |
علامة تحدد ما إذا كان سيتم إنشاء عبارة شبكة منفصلة لكل العملة المستخدمة. يمكن أن تكون القيمة أيًا مما يلي:
|
لا ينطبق | لا |
regNo |
رقم تسجيل المؤسسة. الرقم الذي تُدخله لهذا الموقع هو يظهر في الجزء السفلي من مستندات الفوترة. |
لا ينطبق | لا |
selfBillingAsExchOrg |
إذا تم تفعيل الفواتير التي تستخدم نظام الفوترة الذاتية، للإشارة إلى ما إذا كانت قابلة للاستبدال المؤسسات. يمكن أن تكون القيمة أيًا مما يلي:
|
لا ينطبق | لا |
selfBillingForAllDev |
إذا تم تفعيل الفواتير التي تستخدم نظام الفوترة الذاتية، يشير ذلك إلى ما إذا كانت مفعَّلة لجميع الفواتير. مطوري التطبيقات. بشكل تلقائي، لا يتم إنشاء الفواتير التي تستخدم نظام الفوترة الذاتية إلا لمطوِّري التطبيقات الذين لديهم ووقّعت اتفاقية مع مزود واجهة برمجة التطبيقات. يمكن أن تكون القيمة أيًا مما يلي:
|
خطأ | لا |
separateInvoiceForFees |
علامة تحدّد ما إذا كان سيتم نشر فاتورة منفصلة للرسوم. يمكن أن تكون القيمة أيًا مما يلي:
|
خطأ | نعم |
status |
حالة المؤسسة. تشمل القيم الصالحة ما يلي:
|
لا ينطبق | لا |
supportedBillingType |
نموذج الدفع الخاص بالمطوِّر المستخدَم للفوترة يمكن أن تكون القيمة واحدة مما يلي:
يُرجى الاطِّلاع على ضبط أنواع الفوترة بنظام الدفع المُسبَق أو بنظام الدفع عند الاستخدام باستخدام واجهة برمجة التطبيقات. |
مسبقة الدفع | نعم |
taxModel |
ملاحظة: لا ينطبق هذا الإجراء إلا في حال إعداد خطط أسعار مشاركة الأرباح وكنت تريد لإنشاء مستندات الفوترة نموذج الضريبة لخطط معدّل مشاركة الأرباح الذي يحدّد نوع مستندات الفوترة المطلوبة تشمل القيم الصالحة ما يلي:
|
لا ينطبق | نعم |
taxNexus |
البلد الذي تم تسجيل المؤسسة فيه لأغراض ضريبية. |
لا ينطبق | لا |
taxRegNo |
رقم التسجيل الضريبي للمؤسسة أو تسجيل ضريبة القيمة المضافة إذا كان ذلك منطبقًا. هذه الخاصية اختيارية لأن رقم التسجيل الضريبي أو لا يسري رقم التسجيل في ضريبة القيمة المضافة في كل البلدان. الرقم الذي تُدخله لهذا أسفل مستندات الفوترة. |
لا ينطبق | لا |
transactionRelayURL |
عنوان URL لنظام آخر يمكن نقل المعاملات إليه، مثل بيانات المستودع. |
لا ينطبق | لا |
timezone |
معرِّف المنطقة الزمنية لعمليات المؤسسة، مثل أمريكا/نيويورك/يورك أو أوروبا/باريس. اختصارات المناطق الزمنية، مثل UTC، وEST (الشرقية) ويتوفر أيضًا التوقيت الرسمي) أو CET (توقيت وسط أوروبا). |
لا ينطبق | نعم |
إلغاء إعدادات الملف الشخصي لتحقيق الربح لشركة أو مطوِّر تطبيقات
يمكنك إلغاء إعدادات الملف الشخصي لتحقيق الربح لشركة أو مطوّر تطبيقات باستخدام واجهة المستخدم أو واجهة برمجة التطبيقات، كما هو موضَّح في الأقسام التالية: