מילון מונחים

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

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

מונח	הגדרה
API	שרת proxy שמשמש כחזית של ממשק ה-API הקיים. במקום לקרוא ל-API הקיים, המפתחים מתחילים לקרוא ל-API החדש שנוצר על ידי Apigee. החזית הזו מפרידה בין הממשק הציבורי לבין ה-API לקצה העורפי, ומגנה על המפתחים מפני שינויים בקצה העורפי, תוך מתן אפשרות לחדשנות בקצה בלי להשפיע על צוותי הפיתוח הפנימיים. כשמבצעים שינויים בקצה העורפי, המפתחים ממשיכים לבצע קריאות לאותו ממשק API ללא הפרעה. בתרחישים מתקדמים יותר, Apigee מאפשר לחשוף כמה ממשקים לאותו API, וכך להתאים אישית את החתימה של ה-API כדי לענות בו-זמנית על הצרכים של נישות שונות של מפתחים.
נתיב הבסיס ומשאבי ה-API	ממשק API מורכב מנתיב בסיס וקבוצה של משאבים (שנקראים גם נתיבי משאבים). לכל ממשק API מגדירים כתובת URL ברמה הבסיסית (root) אחת ומספר נתיבים של משאבים. אפשר לחשוב על ממשק 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 שלכם, תוכלו לבטל ולרענן את המפתח של האפליקציה. בנוסף, אתם יכולים לשלוט בגישה לחבילות של משאבים על ידי ביטול או מחיקה של הגישה למוצרים באפליקציה.
פרטי היתרה	למפתחים בתשלום מראש, היתרה בחשבון של המפתח.
התאמה סגורה	התאמה שהוחלו במסמכי חיוב שפורסמו.
closed billing month	חודש קלנדרי מלא שפורסמו עבורו מסמכי חיוב.
הגבלה בהתאמה אישית	מגבלה (למשל, מגבלה על מספר העסקאות במוצר API) שאפשר להגדיר באופן מפורש באמצעות מונטיזציה. נקרא גם 'מגבלה מפורשת'.
תוכנית תמחור לפי קטגוריה למפתחים	תוכנית תמחור שחלה על כל המפתחים בקטגוריה מסוימת וזמינה לרכישה על ידי כל המפתחים בקטגוריה הזו.
תוכנית תעריפים למפתחים	תוכנית תמחור שחלה על מפתח ספציפי וזמינה לרכישה רק על ידו.
סוכן שחשף את המידע	במשפט המסחרי, אדם שמורשה לפעול בשם אדם אחר (שנקרא חשבון הלקוח) כדי ליצור קשר משפטי עם צד שלישי. למונטיזציה, אפשר להגדיר מודל מס לתוכנית של חלוקת הכנסות, כך שספק ה-API יפעל בתור סוכן מובהק של המפתח כדי לאסוף הכנסות (ואולי גם מיסים על מכירות) בשם המפתח.
מודל המס שפורסם	מודל מס שבו ספק ה-API פועל כסוכן שמצוין של המפתח.
environment	הקשר של ביצוע בזמן ריצה לממשקי API. כדי שניתן יהיה לגשת ל-API בסביבת זמן ריצה, צריך לפרוס אותו בסביבה. כברירת מחדל, לארגונים ב-Apigee מוקצות שתי סביבות: 'test' ו-'prod'. הסביבה 'test' משמשת בדרך כלל לפריסה של ממשקי API שנמצאים בבדיקה. הסביבה 'prod' משמשת בדרך כלל לפריסה של ממשקי API לשימוש בסביבת הייצור.
מודל מס משולב	מודל מס שבו ספק ה-API פועל כסוכן שמצוין של המפתח. עם זאת, ספק ה-API משלם את מס המכירות שנאסף מהמנויים שלו לרשויות המס המקומיות בשם המפתח.
מגבלה משתמעת	מגבלה (למשל, מגבלה על היתרה של תשלום מראש של מפתח) שהוגדרה על ידי מונטיזציה.
מונטיזציה	רכיב של Apigee Edge Developer Services שמספק דרך גמישה וקלה לייצור הכנסות (מונטיזציה) ממוצרים של ממשקי API.
הסכום שנוצל בחודש	השימוש הכולל של המפתח בחודש נתון, כולל עמלת ההגדרה + עמלת העסקה + עמלה קבועה.
תשלומים חודשיים	התשלומים הקבועים שמפתחים מקבלים על סמך התוכניות שנרכשו. תוכניות התמחור יכולות לכלול תשלום קבוע שמחויב מהמפתח בכל חודש, ללא קשר לשימוש.
דף יתרות	מסמך פיננסי שבו מוצגים היתרות נטו בין חשבוניות לדפי חשבון של חלוקת הכנסות.
פתיחת ההתאמה	התאמה שעדיין לא הוחלו במסמכי החיוב שפורסמו.
open billing month	חודש קלנדרי מלא שלא פורסמו לגביו מסמכי חיוב "סופיים".
ארגון	מאגר לכל האובייקטים בחשבון Apigee, כולל ממשקי API, מוצרי API, חבילות API, אפליקציות ומפתחים. נדרש חשבון משתמש לכל ארגון שבו אתם חברים. (לרוב המשתמשים יהיה חשבון בארגון אחד בלבד). עליכם לספק את פרטי הכניסה (שם משתמש וסיסמה) ואת שם הארגון בכל בקשת API ששולחים.
קטלוג חבילות	רשימה של חבילות API. כל חבילה מופיעה עם מוצרי ה-API ותוכניות התמחור שלה.
יתרה מההפקדה	סכום כסף שזמין למפתח בתשלום מראש, כדי לשלם מראש על חבילות API.
מפתח בתשלום מראש	מפתח שמשלם מראש על השימוש במוצר API. כאשר משתמשים במוצר ה-API, הכספים מנוכים מהיתרה של המפתח ששילם מראש. המפתח צריך לשמור על יתרה מספקת בתשלום מראש כדי לרכוש את מוצר ה-API. ספק ה-API מקצה למפתחים סטטוס של תשלום מראש או תשלום לאחר השימוש.
מדיניות	שלב עיבוד שמתבצע כיחידת לוגיקה אטומית שניתנת לשימוש חוזר בתוך תהליך API. כללי מדיניות אופייניים כוללים ניתוב בקשות לנקודת הקצה המתאימה, טרנספורמציה של פורמט ההודעה, אכיפת בקרת הגישה, קריאה לשירותים מרוחקים לקבלת מידע נוסף, אנונימיזציה של מידע רגיש ממשתמשים חיצוניים, בדיקת תוכן ההודעות לאיתור איומים פוטנציאליים, שמירת תגובות נפוצות במטמון כדי לשפר את הביצועים ועוד. אפשר להפעיל את כללי המדיניות באופן מותנה על סמך התוכן או ההקשר של בקשה או הודעת תגובה. לדוגמה, אפשר להריץ מדיניות טרנספורמציה כדי להתאים אישית את פורמט התשובה אם הודעת הבקשה נשלחה מסמארטפון.
מפתח בתשלום לאחר השימוש (postpaid)	מפתח שמחויב מדי חודש (באמצעות חשבונית) על השימוש במוצרי API. המפתח משלם על השימוש במוצרי ה-API בהתאם לתנאי התשלום שהוגדרו בתוכניות שכלולות בחשבונית. ספק ה-API הוא זה שמקצה למפתחים את הסטטוס 'תשלום לאחר השימוש' או 'תשלום מראש'.
מחירים	טווח מחירים אפשרי שבו אפשר לשווק משהו.
תוכנית תעריפים של מחירון	תוכנית תמחור שבה המפתח מחויב בתעריף קבוע או משתנה על כל עסקה שכוללת מוצר API לייצור הכנסות.
תוכנית תמחור	מפרט של החיובים, החיובים האחרים וחלוקת ההכנסות על השימוש במוצרי API שמוצעים בחבילת API שמופעלת בה מונטיזציה.
נתיב המשאב	נתיב משאב הוא קונספט של REST, מזהה משאבים אחיד (URI) שמזהה את נתיב הרשת למשאב נתון.
תוכנית של שיעור חלוקת הכנסות	תוכנית תמחור שבה אחוז מההכנסות שמתקבלות מכל עסקה שמערבת מוצר API שמופעלת בו מונטיזציה משותף עם מפתח האפליקציה שמגיש את הבקשה.
תוכנית חלוקת הכנסות ותעריפון	תוכנית תמחור שבה אחוז מההכנסות שמתקבלות מכל עסקה שמערבת מוצר API שמופעלת בו מונטיזציה משותף עם מפתח האפליקציה שמגיש את הבקשה. המפתח גם מחויב בעמלה קבועה או משתנה על כל עסקה.
חשבונית לחיוב עצמי	מסמך פיננסי שנוצר במקום דף חשבון של חלוקת הכנסות. הוא כולל פירוט של הסכום המגיע למפתח, ומשמש חשבונית לספק ה-API מטעם המפתח.
תוכנית תעריף רגילה	תוכנית תמחור שזמינה לרכישה לכל המפתחים.
מס	המס הכולל שחלה על השימוש והעמלות של המפתח.
להוסיף כסף	הפעולה שמפתח בתשלום מראש מבצע כדי להוסיף כסף ליתרה של התשלום מראש.
מדיניות תיעוד העסקאות	מנגנון שמאפשר למונטיזציה לתעד פרמטרים של עסקאות ומאפיינים מותאמים אישית. המידע הזה נדרש לצורך עיבוד המונטיזציה, למשל החלת תוכניות תמחור על בקשות API ותשובות API על סמך המאפיינים המותאמים אישית שנשמרים בכל עסקה.
סוכן לא ידוע	ארגון (או מפעיל) שמשתתף באספקה הבסיסית של האפליקציות, כך שהוא נחשב לרוכש התוכן מטעם המפתח (למטרות מס בלבד). כארגון (או מפעיל) ששומר על סודיות, אפשר לגבות מיסים מחובת משתמשי הקצה ולתעד אותם. הסטטוס הזה רלוונטי רק למטרות מס – הסטטוס המשפטי של המפתח בשרשרת האספקה לא מושפע ממנו.
מודל מס לא ידוע	מודל מס שבו ספק ה-API מנכה את המס שנאסף ממשתמשי הקצה ומשלם אותו לרשויות המס המקומיות.
גרסה	הגרסה של ממשק ה-API למפתחים. לדוגמה, pivotaltracker.com/services/v3 או api.enterprise.apigee.com/v1. (המונח הזה שונה מ'גרסה', שהיא החבילה הממוספרת של ההגדרות והמדיניות שבשליטת גרסאות, שמקובצות ב-API Proxy. בקיצור, לממשקי API יש גרסאות, ולשרתי proxy ל-API יש גרסאות מתוקנות.