شما در حال مشاهده مستندات Apigee Edge هستید.
به مستندات Apigee X مراجعه کنید . اطلاعات
مفاهیم متعددی وجود دارند که ایدههای رایج با معنای منحصر به فرد در آپیجی هستند.
| مدت | تعریف |
|---|---|
| رابط برنامهنویسی کاربردی | یک پروکسی که به عنوان یک نما برای API موجود شما عمل میکند. توسعهدهندگان به جای فراخوانی API موجود، شروع به فراخوانی API جدید تولید شده توسط Apigee میکنند. این نما، رابط عمومی شما را از API backend شما جدا میکند و توسعهدهندگان را از تغییرات backend محافظت میکند، در حالی که شما را قادر میسازد بدون تأثیر بر تیمهای توسعه داخلی خود، در لبه نوآوری کنید. همانطور که تغییرات backend را ایجاد میکنید، توسعهدهندگان همچنان بدون وقفه همان API را فراخوانی میکنند. در سناریوهای پیشرفتهتر، Apigee به شما امکان میدهد چندین رابط را در معرض همان API قرار دهید و شما را آزاد میکند تا امضای یک API را برای برآورده کردن نیازهای بخشهای مختلف توسعهدهندگان به طور همزمان سفارشی کنید. |
| مسیر پایه API و منابع | یک API از مسیر پایه و مجموعهای از منابع (که به عنوان مسیرهای منبع نیز شناخته میشوند) تشکیل شده است. برای هر API، شما یک URL ریشه و چندین مسیر منبع تعریف میکنید. میتوانید یک API را به سادگی به عنوان مجموعهای از URIها در نظر بگیرید که همه آنها یک مسیر پایه مشترک دارند. برای آسانتر کردن مدیریت APIهای شما، Apigee این URIهای خام را با نامهای نمایشی و توضیحات تکمیل میکند. |
| مصرفکننده API | مترادف با «توسعهدهندهی اپلیکیشن» که از APIهای ایجاد شده توسط یک ارائهدهندهی API استفاده میکند. |
| توسعهدهنده API | یک مهندس نرمافزار در یک سازمان ارائهدهنده API که APIها را میسازد. این APIها توسط توسعهدهندگان اپلیکیشن (مصرفکنندگان API) برای ساخت اپلیکیشنها استفاده میشوند. |
| بسته API | مجموعهای از محصولات API که به صورت یک بسته به توسعهدهندگان ارائه میشوند و معمولاً با یک طرح تعرفهای مرتبط هستند. |
| محصول API | مجموعهای از منابع API (URI) که با یک طرح خدماتی ترکیب شده و به عنوان یک بسته به توسعهدهندگان ارائه میشود. محصول API همچنین میتواند شامل برخی فرادادههای خاص برای کسبوکار شما برای نظارت یا تجزیه و تحلیل باشد. یک یا چند منبع را میتوان با گنجاندن آنها در یک محصول API، که سپس میتواند در یک بسته API برای کسب درآمد قرار گیرد، کسب درآمد کرد. |
| ارائه دهنده API | یک ارائهدهنده API، APIهایی (با استفاده از Edge) برای استفاده مصرفکنندگان API (توسعهدهندگان برنامه) میسازد. |
| توسعهدهنده اپلیکیشن | در اج، توسعهدهندگان اپلیکیشن، اپلیکیشنهای خود را در یک ارائهدهندهی API ثبت میکنند و به این ترتیب، کلیدهای API مورد نیاز برای فراخوانی پروکسیهای API آن ارائهدهنده را دریافت میکنند. |
| برنامهها | توسعهدهندگان شما از برنامهها برای دسترسی به منابع موجود در محصولات API شما استفاده میکنند. وقتی یک برنامه ایجاد میکنید، محصول API را برای گنجاندن انتخاب میکنید و Apigee یک کلید تولید میکند. هر برنامه یک کلید واحد دارد که دسترسی به چندین محصول API را فراهم میکند. برنامهها به شما امکان میدهند کنترل کنید چه کسی میتواند به منابع شما دسترسی داشته باشد. میتوانید با لغو و بهروزرسانی کلید یک برنامه، کنترل کنید که چه کسی به محصولات API شما دسترسی دارد. و میتوانید با لغو یا حذف دسترسی به محصولات موجود در یک برنامه، دسترسی به مجموعهای از منابع را کنترل کنید. |
| جزئیات موجودی | برای یک توسعهدهندهی پیشپرداخت، موجودی حساب توسعهدهنده. |
| تنظیم بسته | تعدیلی که در اسناد صورتحساب منتشر شده اعمال شده است. |
| ماه صورتحساب بسته | یک ماه تقویمی کامل که اسناد صورتحساب برای آن منتشر شده است. |
| محدودیت سفارشی | محدودیتی (مانند محدودیت تعداد تراکنشهای یک محصول API) که میتوانید به صراحت با استفاده از کسب درآمد تنظیم کنید. همچنین محدودیت صریح نامیده میشود. |
| طرح نرخ دسته توسعهدهندگان | یک طرح تعرفهای که برای همه توسعهدهندگان در یک دسته خاص اعمال میشود و برای خرید توسط همه توسعهدهندگان در آن دسته در دسترس است. |
| طرح نرخ توسعهدهنده | یک طرح تعرفهای که برای یک توسعهدهنده خاص اعمال میشود و فقط توسط همان توسعهدهنده قابل خریداری است. |
| عامل افشا شده | در قانون تجارت، شخصی که مجاز است از طرف شخص دیگری (که به او مدیر میگویند) برای ایجاد یک رابطه حقوقی با شخص ثالث اقدام کند. در کسب درآمد، میتوان یک مدل مالیاتی برای یک طرح درآمد مشترک تنظیم کرد، به طوری که ارائهدهنده API به عنوان نماینده آشکار توسعهدهنده برای جمعآوری درآمد (و احتمالاً مالیات فروش) از طرف توسعهدهنده عمل کند. |
| مدل مالیاتی افشا شده | یک مدل مالیاتی که در آن ارائهدهنده API به عنوان نماینده افشا شده توسعهدهنده عمل میکند. |
| محیط زیست | یک زمینه اجرای زمان اجرا برای APIها. یک API قبل از اینکه بتواند در زمان اجرا قابل دسترسی باشد، باید در یک محیط مستقر شود. به طور پیشفرض، سازمانهای Apigee با دو محیط تجهیز شدهاند: 'test' و 'prod'. محیط 'test' معمولاً برای استقرار APIهایی که در حال آزمایش هستند استفاده میشود. محیط 'prod' معمولاً برای استقرار APIها برای استفاده در محیط عملیاتی استفاده میشود. |
| مدل مالیاتی ترکیبی | مدل مالیاتی که در آن ارائهدهنده API به عنوان نماینده افشا شده توسعهدهنده عمل میکند. با این حال، ارائهدهنده API مالیات فروش جمعآوریشده از مشترکین خود را از طرف توسعهدهنده به مقامات مالیاتی محلی پرداخت میکند. |
| حد ضمنی | محدودیتی (مانند محدودیت موجودی پیشپرداخت توسعهدهنده) که توسط کسب درآمد تعیین میشود. |
| کسب درآمد | بخشی از خدمات توسعهدهندگان Apigee Edge که روشی آسان و انعطافپذیر برای کسب درآمد از محصولات API ارائه میدهد. |
| مبلغ ماهانه استفاده شده | کل استفاده یک توسعهدهنده برای یک ماه معین، که شامل هزینه راهاندازی + هزینه تراکنش + هزینه دورهای میشود. |
| پرداختهای ماهانه | پرداختهای دورهای که توسط یک توسعهدهنده بر اساس پلنهای خریداریشده انجام میشود. پلنهای نرخی میتوانند هزینه دورهای داشته باشند که هر ماه صرف نظر از میزان استفاده، از توسعهدهنده دریافت میشود. |
| صورت خالصسازی | یک سند مالی که مانده خالص بین فاکتورها و صورتهای سهم درآمد را نشان میدهد. |
| تنظیم باز | تعدیلی که هنوز در اسناد صورتحساب منتشر شده اعمال نشده است. |
| ماه صورتحساب باز | یک ماه تقویمی کامل که اسناد صورتحساب «نهایی» برای آن منتشر نشده است. |
| سازمان | یک محفظه برای تمام اشیاء موجود در حساب Apigee شما، شامل APIها، محصولات API، بستههای API، برنامهها و توسعهدهندگان. برای هر سازمانی که ممکن است عضو آن باشید، یک حساب کاربری لازم است. (بیشتر کاربران فقط در یک سازمان حساب کاربری خواهند داشت.) شما باید اعتبارنامههای خود (نام کاربری و رمز عبور) و نام سازمان خود را با هر درخواست API که ارسال میکنید، ارائه دهید. |
| کاتالوگ بسته بندی | فهرستی از بستههای API. هر بسته به همراه محصولات API و طرحهای نرخگذاری آن فهرست شده است. |
| مانده پیشپرداخت | مبلغی که یک توسعهدهندهی پیشپرداخت میتواند از قبل برای بستههای API پرداخت کند. |
| توسعهدهنده پیشپرداخت | توسعهدهندهای که برای استفاده از یک محصول API از قبل هزینه پرداخت میکند. هنگام استفاده از محصول API، وجوه از موجودی توسعهدهنده پیشپرداخت کسر میشود. توسعهدهنده باید موجودی پیشپرداخت کافی برای خرید محصول API را حفظ کند. وضعیت پیشپرداخت یا پسپرداخت توسط ارائهدهنده API به توسعهدهندگان اختصاص داده میشود. |
| سیاست | یک مرحله پردازش که به عنوان یک واحد منطقی اتمیک و قابل استفاده مجدد در جریان API اجرا میشود. سیاستهای معمول شامل مسیریابی درخواستها به نقطه انتهایی مناسب، تبدیل فرمت پیام، اعمال کنترل دسترسی، فراخوانی سرویسهای راه دور برای اطلاعات بیشتر، پنهان کردن دادههای حساس از کاربران خارجی، بررسی محتوای پیام برای تهدیدات بالقوه، ذخیره پاسخهای رایج برای بهبود عملکرد و غیره است. سیاستها ممکن است به صورت مشروط بر اساس محتوا یا زمینه یک پیام درخواست یا پاسخ اجرا شوند. به عنوان مثال، یک سیاست تبدیل ممکن است برای سفارشیسازی فرمت پاسخ در صورتی که پیام درخواست از یک تلفن هوشمند ارسال شده باشد، اجرا شود. |
| توسعهدهنده پسپرداخت | توسعهدهندهای که ماهانه (از طریق فاکتور) برای استفاده از محصولات API صورتحساب دریافت میکند. توسعهدهنده هزینه استفاده از محصولات API را بر اساس شرایط پرداخت تعیینشده توسط طرح(های) موجود در فاکتور پرداخت میکند. وضعیت پسپرداخت یا پیشپرداخت برای توسعهدهندگان توسط ارائهدهنده API تعیین میشود. |
| نقاط قیمت | طیف وسیعی از قیمتهای ممکن که میتوان چیزی را با آنها به بازار عرضه کرد. |
| طرح نرخ کارت نرخ | طرحی برای نرخگذاری که در آن، توسعهدهنده برای هر تراکنش مربوط به یک محصول API پولی، نرخ ثابت یا متغیری دریافت میکند. |
| طرح نرخ | مشخصات هزینهها، سایر هزینهها و سهم درآمد برای استفاده از محصولات API ارائه شده در یک بسته API پولی. |
| منبع مسیر | یک مفهوم RESTful، یک مسیر منبع، یک منبع شناساییشدهی یکسان (URI) است که مسیر شبکه به یک منبع معین را مشخص میکند. |
| طرح نرخ سهم درآمد | یک طرح نرخ که در آن درصدی از درآمد حاصل از هر تراکنش مربوط به یک محصول API پولی با توسعهدهنده برنامهای که درخواست را صادر میکند، به اشتراک گذاشته میشود. |
| طرح سهم درآمد و کارت نرخ | طرحی برای نرخگذاری که در آن درصدی از درآمد حاصل از هر تراکنش مربوط به یک محصول API پولی با توسعهدهندهی اپلیکیشنی که درخواست را صادر کرده است، تقسیم میشود. همچنین از توسعهدهنده برای هر تراکنش، کارمزد ثابت یا متغیری دریافت میشود. |
| فاکتور خوداظهاری | یک سند مالی که به جای صورتحساب سهم درآمد ایجاد میشود. این سند، مبلغ بدهی به توسعهدهنده را با جزئیات نشان میدهد و از طرف توسعهدهنده، به عنوان فاکتور برای ارائهدهنده API عمل میکند. |
| طرح نرخ استاندارد | یک طرح تعرفهای که برای خرید توسط همه توسعهدهندگان در دسترس است. |
| مالیات | کل مالیات اعمال شده بر میزان استفاده و هزینههای یک توسعهدهنده. |
| شارژ کنید | اقدامی که توسط یک توسعهدهندهی پیشپرداخت برای افزودن وجه به ماندهی پیشپرداخت انجام میشود. |
| سیاست ثبت تراکنش | مکانیزمی که امکان کسب درآمد را برای ثبت پارامترهای تراکنش و ویژگیهای سفارشی فراهم میکند. کسب درآمد برای انجام پردازشهای کسب درآمد خود، مانند اعمال طرحهای نرخ به درخواستها و پاسخهای API بر اساس ویژگیهای سفارشی ثبت شده در هر تراکنش، به این اطلاعات نیاز دارد. |
| عامل ناشناس | سازمانی (یا اپراتوری) که در عرضه اساسی برنامهها مشارکت دارد، به طوری که فرض میشود محتوا را از طرف توسعهدهنده خریداری میکند (فقط برای مقاصد مالیاتی). به عنوان یک نماینده ناشناس، سازمان (یا اپراتور) میتواند مالیاتهای معوقه را از کاربران نهایی جمعآوری و محاسبه کند. این وضعیت فقط برای مقاصد مالیاتی مرتبط است - وضعیت حقوقی توسعهدهنده در زنجیره تأمین تحت تأثیر قرار نمیگیرد. |
| مدل مالیاتی افشا نشده | یک مدل مالیاتی که در آن ارائهدهنده API مالیات جمعآوریشده را از کاربران نهایی کسر کرده و به مقامات مالیاتی محلی پرداخت میکند. |
| نسخه | نسخه رابط API که در دسترس توسعهدهندگان است. برای مثال، pivotaltracker.com/services/v3 یا api.enterprise.apigee.com/v1 . (این اصطلاح با «نسخه» که بسته شمارهگذاری شده و کنترلشده از پیکربندی و سیاستهای موجود در یک پروکسی API است، متفاوت است. به طور خلاصه، رابطهای API دارای نسخه هستند، در حالی که پروکسیهای API دارای نسخه هستند.) |