مدیریت نمایه سازمان

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید. اطلاعات

بخش‌های زیر نمایه سازمان را معرفی می‌کند و توضیح می‌دهد که چگونه می‌توانید آن را بااستفاده از واسط کاربر و میانای برنامه‌سازی کاربردی مدیریت کنید.

درباره نمایه سازمان

به‌عنوان بخشی از راه‌اندازی اولیه درآمدزایی، تیم پیکربندی Apigee Edge نمایه سازمان شما را راه‌اندازی می‌کند.

باید نمایه سازمان را ویرایش کنید تا اطلاعات مربوط به سازمانتان را درصورت لزوم اضافه یا به‌روز کنید. برای مثال، ممکن است لازم باشد نوع صورت‌حساب، تنظیمات ارز، یا مدل مالیات را به‌روز کنید.

اطلاعات پایه درباره سازمانتان را پیکربندی کنید، ازجمله:

• نام سازمان، نشانی، و کشور فعالیت
• نوع صورت‌حساب (پیش‌پرداخت، پس‌پرداخت، یا هر دو)، همان‌طور که در آشنایی با نوع صورت‌حساب توضیح داده شده است
• چرخه صورت‌حساب (متناسب با تاریخ یا ماه تقویمی)
• واحد پول پایه
• مدل مالیاتی مورد استفاده سازمان شما

می‌توانید نمایه سازمانتان را بااستفاده از واسط کاربر و میانای برنامه‌سازی کاربردی، همان‌طور که در بخش‌های زیر توضیح داده شده است، مدیریت کنید.

کاوش صفحه «نمایه سازمان»

به صفحه «نمایه سازمان» که در زیر توضیح داده شده است دسترسی پیدا کنید.

ویرایش نمایه سازمان بااستفاده از «میانای کاربر»

برای ویرایش نمایه سازمان بااستفاده از واسط کاربر:

1. به صفحه نمایه سازمان دسترسی پیدا کنید.
2. روی ویرایش کلیک کنید.
3. در بخش نام و اطلاعات، نام سازمان و کشور فعالیت را ویرایش کنید.
4. در بخش مالیات و ارز، فیلدهای زیر را ویرایش کنید:

   فیلد	شرح
   مدل مالیات	توجه: فقط درصورتی اعمال می‌شود که طرح‌های نرخ توزیع سهم درآمد راه‌اندازی کرده باشید و بخواهید سند صورت‌حساب تولید کنید. مدل مالیاتی برای طرح‌های نرخ توزیع سهم درآمد که نوع اسناد صورت‌حساب موردنیاز را مشخص می‌کند. مقادیر معتبر شامل موارد زیر است: شفاف‌سازی‌شده: ارائه‌دهنده «میانای برنامه‌سازی کاربردی» به‌عنوان نماینده شفاف‌سازی‌شده توسعه‌دهنده عمل می‌کند. درآمد ناخالص (شامل مالیات فروش) جمع‌آوری‌شده از کاربر نهایی به توسعه‌دهنده منتقل می‌شود. کارمزد ارائه‌دهنده API از توسعه‌دهنده در قالب صورت‌حساب کارمزد دریافت می‌شود. ارائه‌دهنده «میانای برنامه‌سازی کاربردی» مالیات فروش جمع‌آوری‌شده از کاربر نهایی را مدیریت نمی‌کند و گزارش مالیات فروش برعهده توسعه‌دهنده است. افشا نشده: ارائه‌دهنده API به‌عنوان نماینده افشا نشده توسعه‌دهنده عمل می‌کند و مالیات جمع‌آوری‌شده از کاربران نهایی را کسر می‌کند و به مقامات مالیاتی محلی پرداخت می‌کند. توسعه‌دهنده برای سهم درآمد خالص قابل پرداخت به توسعه‌دهنده (پس‌از کسر مالیات فروش و کارمزد ارائه‌دهنده API) برای ارائه‌دهنده API صورت‌حساب صادر می‌کند. ترکیبی: ارائه‌دهنده «میانای برنامه‌سازی کاربردی» به‌عنوان نماینده شفاف توسعه‌دهنده عمل می‌کند. بااین‌حال، ارائه‌دهنده API مالیات فروش جمع‌آوری‌شده از مشترکان خود را ازطرف توسعه‌دهنده به مراجع مالیاتی محلی پرداخت می‌کند. ارائه‌دهنده API درآمد باقی‌مانده را به توسعه‌دهنده منتقل می‌کند و سپس صورت‌حساب کارمزد را صادر می‌کند.
   واحد پول	واحدهای پولی که سازمانتان پشتیبانی می‌کند. برای توزیع سهم درآمد، کارت نرخ، و طرح‌های فقط کارمزد، از ارز پیش‌فرض برای طرح نرخ شما استفاده می‌شود. وقتی کارت نرخ یا طرح فقط کارمزد ایجاد می‌کنید، می‌توانید با انتخاب از فهرست ارزهای پشتیبانی‌شده، ارز موردنظر را تغییر دهید. به‌صورت اختیاری، می‌توانید حداقل مبلغ واریز را که توسعه‌دهندگان نرم‌افزار می‌توانند به تراز حساب پیش‌پرداخت خود برای هر ارز اضافه کنند تنظیم کنید. برای افزودن واحد پول: روی افزودن واحد پول کلیک کنید. ارزی را از منوِ کرکره‌ای در فیلد ارز انتخاب کنید. به‌صورت اختیاری، حداقل مبلغی را که توسعه‌دهندگان برنامه می‌توانند به تراز حساب پیش‌پرداخت خود به ارز مشخص‌شده در فیلد حداقل مبلغ اضافه کردن اضافه کنند تنظیم کنید. روی افزودن کلیک کنید. درصورت تمایل، با کلیک کردن روی دکمه رادیویی مربوطه، آن را به‌عنوان واحد پول پیش‌فرض تنظیم کنید. برای افزودن ارزهای دیگر، مراحل را تکرار کنید. برای حذف کردن ارز، مکان‌نما را روی ارزی که می‌خواهید حذف کنید قرار دهید و روی کلیک کنید.

5. شرایط خدمات را همان‌طور که در مدیریت شرایط خدمات بااستفاده از میانای کاربری توضیح داده شده است مدیریت کنید.
6. روی ذخیره کلیک کنید.

مدیریت نمایه سازمان بااستفاده از میانای برنامه‌سازی کاربردی

نمایه سازمان را بااستفاده از «میانای برنامه‌سازی کاربردی» مدیریت کنید، همان‌طور که در بخش‌های زیر توضیح داده شده است.

مشاهده نمایه سازمان بااستفاده از API

با صدور درخواست 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

در زیر نمونه‌ای از پاسخ ارائه شده است. برای اطلاعات بیشتر درباره گزینه‌های نشان‌داده‌شده، به ویژگی‌های پیکربندی نمایه سازمان برای API مراجعه کنید.

{
    "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"
}

ویرایش نمایه سازمان بااستفاده از API

با صدور درخواست PUT به /mint/organizations/{org_name} نمایه سازمان را ویرایش کنید. هنگام ویرایش نمایه سازمان، باید همه دارایی‌های نمایه سازمان را مشخص کنید، نه فقط دارایی‌هایی را که ویرایش می‌کنید.

برای ویرایش واحد ارزی پیش‌فرض سازمان، مقدار currency را روی کد ارز ISO 4217 ارز پشتیبانی‌شده‌ای که می‌خواهید به‌عنوان پیش‌فرض تنظیم کنید قرار دهید.

برای مثال، فراخوانی API زیر 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

پیکربندی انواع صورت‌حساب پیش‌پرداخت و پس‌پرداخت بااستفاده از API

حساب‌های توسعه‌دهنده را می‌توان به‌گونه‌ای پیکربندی کرد که از انواع صورت‌حساب زیر استفاده کنند: پیش‌پرداخت، پس‌پرداخت، یا هر دو.

با حساب‌های پیش‌پرداخت، توسعه‌دهندگان هزینه استفاده از APIهای شما را ازقبل پرداخت می‌کنند. مبالغ از تراز پیش‌پرداخت توسعه‌دهنده که ازطریق ارائه‌دهنده پرداخت یکپارچه نگهداری می‌شود کسر می‌شود. توسعه‌دهنده باید تراز پیش‌پرداخت کافی برای خرید میاناهای برنامه‌سازی کاربردی داشته باشد.

در حساب‌های پس‌پرداخت، توسعه‌دهندگان در پایان ماه (ازطریق صورت‌حساب) به‌صورت ماهانه صورت‌حساب دریافت می‌کنند. توسعه‌دهنده براساس شرایط پرداخت تعیین‌شده توسط طرح(های) مندرج در صورت‌حساب، هزینه استفاده از محصولات API را پرداخت می‌کند.

برای پیکربندی انواع صورت‌حساب پیش‌پرداخت و پس‌پرداخت برای سازمانتان، دارایی 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: صورت‌حساب براساس تعداد روزهایی است که محصول API در یک ماه تقویمی استفاده می‌شود.
• ‫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

دارایی‌های پیکربندی نمایه سازمان برای «میانای برنامه‌سازی کاربردی»

نمایه سازمان به شما امکان می‌دهد تا ویژگی‌های پیکربندی زیر را بااستفاده از میانای برنامه‌سازی کاربردی تنظیم کنید.

ملغی کردن تنظیمات نمایه درآمدزایی برای یک شرکت یا توسعه‌دهنده برنامه

تنظیمات نمایه درآمدزایی را برای یک شرکت یا توسعه‌دهنده برنامه بااستفاده از میانای کاربری یا میانای برنامه‌سازی کاربردی لغو کنید، همان‌طور که در بخش‌های زیر توضیح داده شده است:

• مدیریت مشخصه‌های سفارشی برای توسعه‌دهنده برنامه
• مدیریت شرکت‌ها و توسعه‌دهندگان برنامه
• مدیریت توسعه‌دهندگان نرم‌افزار