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