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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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 تنظیم کنید.

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

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

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