درحال مشاهده اسناد Apigee Edge هستید.
به
اسناد Apigee X بروید. اطلاعات
چند مفهوم وجود دارد که ایده‌های رایجی با معنای منحصربه‌فرد در Apigee هستند.
| مدت | تعریف |
|---|---|
| API | پراکسی که به‌عنوان نمای ظاهری برای API موجود شما عمل می‌کند. توسعه‌دهندگان به‌جای فراخوانی میانای برنامه‌سازی کاربردی موجود، شروع به فراخوانی میانای برنامه‌سازی کاربردی جدید تولیدشده توسط Apigee می‌کنند. این نمای بیرونی رابط عمومی شما را از میانای برنامه‌سازی کاربردی زیرینه جدا می‌کند و توسعه‌دهندگان را از تغییرات زیرینه محافظت می‌کند، درحالی‌که به شما امکان می‌دهد بدون تأثیرگذاری بر تیم‌های توسعه داخلی خود، در لبه نوآوری کنید. هم‌زمان با ایجاد تغییرات در زیرینه، توسعه‌دهندگان بدون وقفه به فراخوانی همان «میانای برنامه‌سازی کاربردی» ادامه می‌دهند. در سناریوهای پیشرفته‌تر، Apigee به شما امکان می‌دهد چندین رابط را در همان API نمایان کنید و به شما آزادی می‌دهد تا امضای API را برای برآورده کردن نیازهای مختلف توسعه‌دهندگان به‌طور هم‌زمان سفارشی‌سازی کنید. |
| مسیر پایه و منابع میانای برنامه‌سازی کاربردی | یک API از مسیر پایه و مجموعه‌ای از منابع (که به‌عنوان مسیرهای منبع نیز شناخته می‌شوند) تشکیل شده است. برای هر API، یک نشانی وب ریشه واحد و چندین مسیر منبع تعریف می‌کنید. می‌توانید API را به‌سادگی مجموعه‌ای از نشانی‌های وب درنظر بگیرید که همه آن‌ها مسیر پایه مشترکی دارند. برای آسان‌تر کردن مدیریت میاناهای برنامه‌سازی کاربردی، Apigee این نشانی‌های وب خام را با نام‌های نمایشی و شرح‌ها تکمیل می‌کند. |
| مصرف‌کننده میانای برنامه‌سازی کاربردی | مترادف با «توسعه‌دهنده نرم‌افزار» که از «میاناهای برنامه‌سازی کاربردی» ایجادشده توسط ارائه‌دهنده «میانای برنامه‌سازی کاربردی» استفاده می‌کند. |
| توسعه‌دهنده میانای برنامه‌سازی کاربردی | مهندس نرم‌افزار در سازمان ارائه‌دهنده «میانای برنامه‌سازی کاربردی» که «میاناهای برنامه‌سازی کاربردی» را می‌سازد. توسعه‌دهندگان نرم‌افزار (مصرف‌کنندگان میانای برنامه‌سازی کاربردی) از این میاناهای برنامه‌سازی کاربردی برای ساختن نرم‌افزار استفاده می‌کنند. |
| بسته API | مجموعه‌ای از محصولات API که به‌صورت یک بسته به توسعه‌دهندگان ارائه می‌شود و معمولاً با یک طرح نرخ مرتبط است. |
| محصول میانای برنامه‌سازی کاربردی | مجموعه‌ای از منابع میانای برنامه‌سازی کاربردی (نشانی‌های وب) که با طرح سرویس ترکیب شده و به‌صورت بسته‌ای به توسعه‌دهندگان ارائه می‌شود. محصول API همچنین می‌تواند شامل برخی‌از فراداده‌های مختص کسب‌وکارتان برای پایش یا تجزیه‌وتحلیل باشد. با افزودن یک یا چند منبع به محصول API، می‌توان از آن‌ها درآمدزایی کرد. سپس می‌توان آن‌ها را در بسته API برای درآمدزایی دسته‌بندی کرد. |
| ارائه‌دهنده میانای برنامه‌سازی کاربردی | ارائه‌دهنده API بااستفاده از Edge، میاناهای برنامه‌سازی کاربردی را برای مصرف‌کنندگان API (توسعه‌دهندگان نرم‌افزار) می‌سازد تا از آن‌ها استفاده کنند. |
| توسعه‌دهنده نرم‌افزار | در Edge، توسعه‌دهندگان برنامه برنامه‌هایشان را نزد ارائه‌دهنده میانای برنامه‌سازی کاربردی ثبت می‌کنند، و به این ترتیب توسعه‌دهندگان برنامه کلیدهای میانای برنامه‌سازی کاربردی موردنیاز برای فراخوانی پراکسی‌های میانای برنامه‌سازی کاربردی ارائه‌دهنده را دریافت می‌کنند. |
| برنامه | توسعه‌دهندگان شما از برنامه‌ها برای دسترسی به منابع در محصولات API شما استفاده می‌کنند. وقتی برنامه‌ای ایجاد می‌کنید، محصول API را برای افزودن انتخاب می‌کنید و Apigee کلیدی تولید می‌کند. هر برنامه یک کلید واحد دارد که دسترسی به چندین محصول API را فراهم می‌کند. برنامه‌ها به شما امکان می‌دهند کنترل کنید چه کسی می‌تواند به منابع شما دسترسی داشته باشد. با باطل کردن و بازآوری کلید برنامه می‌توانید کنترل کنید چه کسانی به محصولات API شما دسترسی دارند. همچنین می‌توانید با لغو کردن یا حذف دسترسی به محصولات در یک برنامه، دسترسی به دسته‌های منابع را کنترل کنید. |
| جزئیات تراز | برای توسعه‌دهنده پیش‌پرداخت، تراز حساب توسعه‌دهنده. |
| تعدیل بسته‌شده | تعدیلی که در اسناد صورت‌حساب منتشرشده اعمال شده است. |
| ماه صورت‌حساب بسته‌شده | یک ماه کامل تقویمی که اسناد صورت‌حساب آن منتشر شده است. |
| محدودیت سفارشی | محدودیتی (مانند محدودیت در تعداد تراکنش‌های محصول API) که می‌توانید به‌طور صریح بااستفاده از درآمدزایی تنظیم کنید. به آن حد صریح نیز گفته می‌شود. |
| طرح نرخ دسته توسعه‌دهنده | طرح نرخی که برای همه توسعه‌دهندگان در یک دسته خاص اعمال می‌شود و برای خرید توسط همه توسعه‌دهندگان در آن دسته دردسترس است. |
| طرح نرخ توسعه‌دهنده | طرح نرخی که برای توسعه‌دهنده خاصی اعمال می‌شود و فقط توسط آن توسعه‌دهنده برای خرید دردسترس است. |
| نماینده آشکارشده | در حقوق تجارت، شخصی که مجاز است ازطرف دیگری (به‌نام کارگزار) اقدام کند تا با طرف سوم رابطه قانونی ایجاد کند. در درآمدزایی، یک مدل مالیاتی می‌تواند برای یک طرح درآمد مشترک تنظیم شود به‌طوری‌که ارائه‌دهنده API به‌عنوان یک عامل آشکار توسعه‌دهنده برای جمع‌آوری درآمد (و احتمالاً مالیات فروش) ازطرف توسعه‌دهنده عمل کند. |
| مدل مالیاتی آشکارشده | مدل مالیاتی که در آن ارائه‌دهنده API به‌عنوان کارگزار آشکارشده توسعه‌دهنده عمل می‌کند. |
| محیط | بافت اجرای زمان اجرا برای میاناهای برنامه‌سازی کاربردی. پیش‌از اینکه بتوان در زمان اجرا به یک API دسترسی داشت، باید آن را در محیطی مستقر کرد. به‌طور پیش‌فرض، سازمان‌های Apigee با دو محیط آماده می‌شوند: «test» و «prod». محیط «آزمایشی» معمولاً برای استقرار میاناهای برنامه‌سازی کاربردی درحال آزمایش استفاده می‌شود. محیط «prod» معمولاً برای استقرار میاناهای برنامه‌سازی کاربردی برای استفاده تولیدی استفاده می‌شود. |
| مدل مالیاتی ترکیبی | مدل مالیاتی که در آن ارائه‌دهنده API به‌عنوان کارگزار آشکارشده توسعه‌دهنده عمل می‌کند. بااین‌حال، ارائه‌دهنده API مالیات فروش جمع‌آوری‌شده از مشترکان خود را ازطرف توسعه‌دهنده به مقامات مالیاتی محلی پرداخت می‌کند. |
| محدودیت ضمنی | محدودیتی (مانند محدودیت تراز پیش‌پرداخت توسعه‌دهنده) که توسط درآمدزایی تعیین شده است. |
| درآمدزایی | بخشی از «خدمات توسعه‌دهنده Apigee Edge» که روشی آسان و انعطاف‌پذیر برای درآمدزایی از محصولات API ارائه می‌دهد. |
| مقدار استفاده ماهانه | کل استفاده توسعه‌دهنده برای یک ماه معین، که شامل کارمزد راه‌اندازی + کارمزد تراکنش + کارمزد تکرارشونده می‌شود. |
| پرداخت‌های ماهانه | پرداخت‌های تکرارشونده‌ای که توسعه‌دهنده براساس طرح‌های خریداری‌شده انجام می‌دهد. طرح‌های نرخ می‌تواند کارمزد تکرارشونده‌ای داشته باشد که هر ماه صرف‌نظر از میزان استفاده از توسعه‌دهنده کسر می‌شود. |
| بیانیه تهاتر | سند مالی که ترازهای خالص بین صورت‌حساب‌ها و بیانیه‌های سهم درآمد را نشان می‌دهد. |
| باز کردن تعدیل | تعدیلی که هنوز در اسناد صورت‌حساب منتشرشده اعمال نشده است. |
| باز کردن ماه صورت‌حساب | یک ماه کامل تقویمی که اسناد صورت‌حساب «نهایی» برای آن منتشر نشده است. |
| سازمان | ظرفی برای همه اشیای موجود در حساب Apigee شما، ازجمله میاناهای برنامه‌سازی کاربردی، محصولات میانای برنامه‌سازی کاربردی، بسته‌های میانای برنامه‌سازی کاربردی، برنامه‌ها، و توسعه‌دهندگان. برای هر سازمانی که ممکن است عضو آن باشید، به حساب کاربری نیاز دارید. (اکثر کاربران فقط در یک سازمان حساب دارند.) شما باید اطلاعات اعتباری خود (نام کاربری و گذرواژه) و نام سازمانتان را با هر درخواست 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» دارای بازبینی هستند. |