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

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

بخش‌های زیر نمایه سازمان را معرفی می‌کنند و نحوه مدیریت آن را با استفاده از UI و API شرح می‌دهند.

درباره مشخصات سازمان

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

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

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

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

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

صفحه نمایه سازمان را کاوش کنید

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

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

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

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

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

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

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

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

نمایه سازمان را با استفاده از 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 را به USD و تنظیم مدل مالیاتی را به HYBRID به روز می کند (فیلدهای به روز شده در مثال برجسته شده اند). برای اطلاعات بیشتر درباره گزینه های نشان داده شده، به ویژگی های پیکربندی نمایه سازمان برای API مراجعه کنید.

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ها را حفظ کند.

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

برای پیکربندی انواع صورت‌حساب پیش‌پرداخت و پس‌پرداخت برای سازمانتان، ویژگی supportedBillingType را روی یکی از مقادیر زیر تنظیم کنید تا نشان دهد کدام نوع صورت‌حساب معتبر است: PREPAID ، POSTPAID ، یا BOTH . اگر مقدار را روی BOTH تنظیم کنید، زمانی که یک برنامه‌نویس یا شرکتی را اضافه می‌کنید، پیش‌فرض PREPAID خواهد بود. در این مورد، می‌توانید به صراحت نوع صورت‌حساب را برای یک شرکت یا برنامه‌نویس برنامه با استفاده از API تنظیم کنید، همانطور که در مدیریت شرکت‌ها و توسعه‌دهندگان برنامه توضیح داده شده است.

به عنوان مثال:

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 پیکربندی کنید

برای پیکربندی چرخه صورت‌حساب برای سازمانتان، ویژگی 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

ویژگی های پیکربندی نمایه سازمان برای API

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

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

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

• مدیریت ویژگی های سفارشی برای یک توسعه دهنده برنامه
• مدیریت شرکت ها و توسعه دهندگان اپلیکیشن
• مدیریت توسعه دهندگان اپلیکیشن