مراحل راه اندازی کسب درآمد

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

قبل از اینکه شروع کنی

قبل از شروع استفاده از روش کسب درآمد در سازمان Apigee خود، باید کارهای پیش‌نیاز زیر را انجام دهید:

  • همانطور که در بخش «ایجاد حساب کاربری Apigee Edge» توضیح داده شده است، یک حساب Apigee Edge ایجاد کنید.
  • خرید کسب درآمد. Edge در ابتدا شامل API کسب درآمد یا ادغام کسب درآمد در رابط کاربری مدیریت نیست. شما باید ویژگی کسب درآمد را خریداری کنید تا API کسب درآمد و اجزای رابط کاربری کسب درآمد را در Edge برای سازمان Apigee خود بگنجانید.

پس از خرید امتیاز کسب درآمد، باید مراحل زیر را انجام دهید:

تنظیمات اولیه با Apigee

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

  • چه سازمان شما یک شرکت مخابراتی باشد و چه نباشد.
  • کدام نوع صورتحساب را می‌خواهید برای توسعه‌دهندگانی که طرح‌های نرخ شما را خریداری می‌کنند، پشتیبانی کنید: پیش‌پرداخت، پس‌پرداخت یا هر دو. به بخش حساب‌های پیش‌پرداخت در مقابل پس‌پرداخت مراجعه کنید.
  • اینکه آیا می‌خواهید داده‌های تفصیلی یا خلاصه‌ای از کسب درآمد در سیستم حسابداری شما استخراج شود و فرمت داده‌های مورد نیاز چیست.
  • آدرس پاسخ ایمیل سفارشی. برای اعلان‌های ایمیل کسب درآمد که برای شرکت‌ها و توسعه‌دهندگان ارسال می‌شوند، یک آدرس پیش‌فرض noreply@apigee.com پیکربندی شده است. شما باید یک نام و آدرس پاسخ سفارشی برای سازمان خود درخواست کنید.

تیم پیکربندی Apigee اسکریپتی را برای همگام‌سازی کسب درآمد با سازمان شما و هر توسعه‌دهنده، برنامه و محصول API که با استفاده از Apigee Edge ایجاد کرده‌اید، اجرا می‌کند. پشتیبانی Apigee ممکن است در آینده از شما بخواهد که سازمان خود را همگام‌سازی کنید، همانطور که برای جزئیات بیشتر در بخش همگام‌سازی داده‌های Apigee Edge با کسب درآمد توضیح داده شده است. داده‌های کسب درآمد را همگام‌سازی نکنید، مگر اینکه Apigee دستور داده باشد.

پیکربندی کسب درآمد

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

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

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

شما می‌توانید ارزهایی را که سازمان شما پشتیبانی می‌کند بازیابی کنید و ارزهای پشتیبانی شده را اضافه یا حذف کنید (تا ارزهای مورد استفاده توسط یک توسعه‌دهنده یا یک طرح نرخ را منعکس کنید).

توجه : کسب درآمد به طور خودکار یک کار روزانه را اجرا می‌کند که نرخ ارز را به دلار آمریکا برای هر ارز پشتیبانی شده دریافت می‌کند. به طور پیش‌فرض، این کار هر روز ساعت ۱ ثانیه بعد از نیمه شب اجرا می‌شود. برای جزئیات بیشتر، به بخش زمانبندی کارهای کسب درآمد مراجعه کنید.

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

توجه : شرایط و ضوابط خارج از نمایه سازمان شما قرار دارند. در نمایه سازمان خود، مکان (URL عمومی) شرایط و ضوابط را مشخص می‌کنید. می‌توانید چندین نسخه از شرایط و ضوابط را برای نمایش تغییرات در طول زمان اضافه کنید.

اعمال محدودیت‌های کسب درآمد برای اعمال محدودیت‌های کسب درآمد، سیاست MonetizationLimitsCheck را به پروکسی‌های API پیوست کنید.

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

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

از API های خود درآمد کسب کنید

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

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

جدول زیر مراحل لازم برای کسب درآمد از API های شما را خلاصه می‌کند.

قدم توضیحات
مدیریت بسته‌های محصول API

برای گروه‌بندی محصولات API خود، بسته‌های محصول API ایجاد کنید.

توجه : در رابط کاربری کلاسیک اج و API کسب درآمد، به بسته‌های محصول، بسته‌های API گفته می‌شود.

برای استفاده از API جهت مدیریت بسته‌های محصول API، به موارد زیر مراجعه کنید:

پیکربندی سیاست ثبت تراکنش

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

برای استفاده از API جهت پیکربندی سیاست ثبت تراکنش، به موارد زیر مراجعه کنید:

مدیریت و انتشار طرح‌های نرخ

یک طرح نرخ‌گذاری ایجاد کنید تا رویکرد کسب درآمد برای APIهای خود را تعریف کنید. به عنوان مثال، آیا برای استفاده از API خود نرخ ثابت یا متغیر دریافت می‌کنید؟

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

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

مدیریت کسب درآمد

پس از پیکربندی کسب درآمد و کسب درآمد از API خود، می‌توانید یک یا چند مرحله خلاصه شده در جدول زیر را انجام دهید:

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