מילון מונחים

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

יש כמה מושגים שהם רעיונות נפוצים עם משמעות ייחודית ב-Apigee.

מונח	הגדרה
API	פרוקסי שפועל כחזית עבור ה-API הקיים. במקום לקרוא ל-API הקיים, המפתחים מתחילים לקרוא ל-API החדש שנוצר על ידי Apigee. ה-Facade הזה מפריד את הממשק הציבורי שלכם מה-API של הקצה העורפי, ומגן על המפתחים מפני שינויים בקצה העורפי. בנוסף, הוא מאפשר לכם לחדש בקצה בלי להשפיע על צוותי הפיתוח הפנימיים. בזמן שאתם מבצעים שינויים בבקשות ה-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 (באמצעות Edge) לשימוש של צרכני API (מפתחי אפליקציות).
מפַתח אפליקציות	ב-Edge, מפתחי אפליקציות רושמים את האפליקציות שלהם אצל ספק API. כך מפתחי האפליקציות מקבלים את מפתחות ה-API שהם צריכים כדי לקרוא לשרתי ה-proxy של ספק ה-API.
אפליקציות	המפתחים שלכם משתמשים באפליקציות כדי לגשת למשאבים במוצרי ה-API שלכם. כשיוצרים אפליקציה, בוחרים את מוצר ה-API שרוצים לכלול, ומערכת Apigee יוצרת מפתח. לכל אפליקציה יש מפתח יחיד שמאפשר גישה לכמה מוצרי API. אפליקציות מאפשרות לכם לקבוע למי תהיה גישה למשאבים שלכם. אתם יכולים לקבוע למי תהיה גישה למוצרי ה-API שלכם על ידי ביטול מפתח של אפליקציה ורענון שלו. אתם יכולים גם לשלוט בגישה לחבילות של משאבים על ידי ביטול או מחיקה של הגישה למוצרים באפליקציה.
פרטי יתרה	למפתח שמשלם מראש, היתרה בחשבון הפיתוח.
שינוי סגור אחד ()	התאמה שבוצעה במסמכי חיוב שפורסמו.
חודש חיוב סגור	חודש קלנדרי מלא שפורסמו לגביו מסמכי חיוב.
הגבלה בהתאמה אישית	מגבלה (כמו מגבלה על מספר העסקאות במוצר API) שאפשר להגדיר באופן מפורש באמצעות מונטיזציה. נקראת גם מגבלה מפורשת.
תוכנית תמחור לפי קטגוריית מפתחים	תוכנית תמחור שחלה על כל המפתחים בקטגוריה מסוימת וזמינה לרכישה על ידי כל המפתחים בקטגוריה הזו.
תוכנית תעריפים למפתחים	תוכנית תעריפים שחלה על מפתח ספציפי וזמינה לרכישה רק על ידי אותו מפתח.
סוכן גלוי	במשפט מסחרי, אדם שמורשה לפעול בשמו של אדם אחר (שנקרא המְמַנֶה) כדי ליצור קשר משפטי עם צד שלישי. במונטיזציה, אפשר להגדיר מודל מס לתוכנית לחלוקת הכנסות, כך שספק ה-API פועל כסוכן גלוי של המפתח כדי לגבות הכנסות (ואולי גם מס מכירות) בשם המפתח.
מודל מס גלוי	מודל מס שבו ספק ה-API פועל כסוכן גלוי של המפתח.
environment	הקשר הרצה של ממשקי 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 עם מונטיזציה.
resource path	נתיב משאב הוא מזהה משאבים אחיד (URI) שמזהה את נתיב הרשת למשאב נתון. זהו מושג שקשור ל-RESTful.
תוכנית לחלוקת הכנסות	תוכנית תמחור שבה אחוז מההכנסות שנוצרות מכל עסקה שקשורה למוצר API שמניב הכנסות משותף עם המפתח של האפליקציה ששולחת את הבקשה.
תוכנית של חלוקת הכנסות ומחירון	תוכנית תמחור שבה אחוז מההכנסות שנוצרות מכל עסקה שקשורה למוצר API שמניב הכנסות משותף עם המפתח של האפליקציה ששולחת את הבקשה. המפתח מחויב גם בעמלה קבועה או משתנה על כל עסקה.
חשבונית עצמית	מסמך פיננסי שנוצר במקום דוח חלוקת הכנסות. הדוח כולל פרטים על הסכום שהמפתח חייב, ומשמש כחשבונית לספק ה-API מטעם המפתח.
תוכנית תעריפים רגילה	תוכנית תמחור שזמינה לרכישה על ידי כל המפתחים.
מס	סך המיסים שחלים על השימוש והעמלות של מפתח.
טעינת כרטיס	הפעולה שמבצע מפתח עם תשלום מראש כדי להוסיף כסף ליתרה מההפקדה.
מדיניות בנושא תיעוד עסקאות	מנגנון שמאפשר למונטיזציה לתעד פרמטרים של עסקאות ומאפיינים מותאמים אישית. המידע הזה נחוץ למונטיזציה כדי לבצע את תהליך המונטיזציה, למשל כדי להחיל תוכניות תמחור על בקשות ותשובות של API על סמך המאפיינים המותאמים אישית שנאספים בכל עסקה.
סוכן שלא צוין	ארגון (או מפעיל) שמשתתף באספקת האפליקציות, כך שהוא נחשב כמי שרוכש את התוכן בשם המפתח (למטרות מס בלבד). כסוכן שלא נחשף, הארגון (או המפעיל) יכול לגבות מיסים שמשתמשי הקצה חייבים בהם ולדווח עליהם. הסטטוס הזה רלוונטי רק למטרות מס – הוא לא משפיע על הסטטוס המשפטי של המפתח בשרשרת האספקה.
מודל מס לא גלוי	מודל מיסוי שבו ספק ה-API מנכה את המס שנגבה ממשתמשי הקצה ומשלם אותו לרשויות המס המקומיות.
גרסה	הגרסה של ממשק ה-API שפונה למפתחים. לדוגמה, pivotaltracker.com/services/v3, or api.enterprise.apigee.com/v1. (המונח הזה שונה מ'עדכון', שהוא חבילה ממוספרת של הגדרות ומדיניות עם בקרת גרסאות, שמאוגדת ב-API Proxy. בקיצור, לממשקי API יש גרסאות, ולשרתי proxy ל-API יש גרסאות מתוקנות.