מילון מונחים

כרגע מוצג התיעוד של Apigee Edge.
נכנסים למסמכי התיעוד של Apigee X. מידע

ב-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 שדרושים להם כדי להפעיל את שרתי ה-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. כללי המדיניות הרגילים כוללים ניתוב בקשות לנקודת הקצה המתאימה, טרנספורמציה של פורמט ההודעה, אכיפה של בקרת גישה, התקשרות לשירותים מרוחקים כדי לקבל מידע נוסף, אנונימיזציה של מידע אישי רגיש ממשתמשים חיצוניים, בדיקת תוכן של הודעות לזיהוי איומים פוטנציאליים, שמירה של תשובות נפוצות במטמון לצורך שיפור הביצועים וכו'. ניתן להוציא לפועל כללי מדיניות לפי תנאים, בהתאם לתוכן או להקשר של הבקשה או הודעת התגובה. לדוגמה, ייתכן שנריץ מדיניות טרנספורמציה כדי להתאים אישית את פורמט התשובה אם הודעת הבקשה נשלחה מסמארטפון.
מפתח בתשלום לאחר השימוש (postpay)	מפתח שמחויב באופן חודשי (באמצעות חשבונית) על השימוש במוצרי API. התשלום על השימוש במוצרי API מתבצע על ידי המפתח בהתאם לתנאי התשלום שהוגדרו בתוכניות שכלולות בחשבונית. המפתחים מקבלים סטטוס של תשלום לאחר השימוש או תשלום מראש על ידי ספק ה-API.
נקודות מחיר	טווח של מחירים אפשריים שבהם פריט מסוים משווק.
תוכנית תמחור ותשלומים לתעריף של כרטיס אשראי	תוכנית תעריפים שבה המפתח מחויב בתעריף קבוע או משתנה על כל עסקה שכוללת מוצר של ממשק API שמופעלת בו מונטיזציה.
תוכנית תעריפים	פירוט של העמלות, החיובים האחרים וחלוקת ההכנסות על השימוש במוצרי API שמוצעים בחבילה של ממשק ה-API שעבר מונטיזציה.
נתיב המשאב	בקונספט מסוג RESTful, נתיב משאב הוא משאב אחיד שמזוהה (URI) שמזהה את נתיב הרשת למשאב נתון.
תוכנית של חלוקת ההכנסות	תוכנית תעריפים שבה אחוז מההכנסות שנוצרו מכל עסקה עם מוצר של ממשק ה-API למונטיזציה, משותף עם מפתח האפליקציה שהגיש את הבקשה.
חלוקת הכנסות ותוכנית מחירון	תוכנית תעריפים שבה אחוז מההכנסות שנוצרו מכל עסקה עם מוצר של ממשק ה-API למונטיזציה, משותף עם מפתח האפליקציה שהגיש את הבקשה. המפתח גם מחויב בעמלה קבועה או משתנה עבור כל עסקה.
חשבונית לחיוב עצמי	מסמך פיננסי שמופק במקום הצהרת חלוקת הכנסות. בהודעה מפורט את הסכום לתשלום למפתח, ומשמשת כחשבונית לספק ה-API בשם המפתח.
תוכנית תעריפים רגילה	תוכנית תמחור ותשלומים שזמינה לכל המפתחים.
tax	המס הכולל שחל על השימוש והעמלות של המפתח.
הוספת כסף	הפעולה שננקטה על ידי מפתח בתשלום מראש כדי להוסיף כספים ליתרה ששולמה מראש.
המדיניות בנושא תיעוד עסקאות	מנגנון שמאפשר מונטיזציה כדי לתעד פרמטרים של טרנזקציות ומאפיינים מותאמים אישית. צוות המונטיזציה צריך את המידע הזה כדי לבצע את עיבוד המונטיזציה, לדוגמה: החלת תוכניות תמחור ותשלומים על בקשות API ותגובות לפי המאפיינים המותאמים אישית שתועדו בכל עסקה.
סוכן לא סגור	ארגון (או מפעיל) שלוקח חלק באספקת האפליקציות הבסיסית, כך שהוא ייחשב שרכש את התוכן בשם המפתח (למטרות מס בלבד). כסוכנים שלא צוינו, הארגון (או המפעיל) יכול לגבות את המיסים שמגיעים ממשתמשי הקצה ולתחשב בהם. הסטטוס הזה רלוונטי רק למטרות מס – הסטטוס המשפטי של המפתח בשרשרת האספקה לא מושפע.
מודל מס לא סגור	מודל מס שבו ספק ה-API מנכה את המס שנגבה ממשתמשי הקצה ומשלם אותו לרשויות המס המקומיות.
גרסה	הגרסה של ממשק ה-API למפתחים. לדוגמה, pivotaltracker.com/services/v3 או api.enterprise.apigee.com/v1. (מונח זה שונה מה'גרסה', שהיא חבילה ממוספרת של הגדרות אישיות ושל המדיניות במסגרת בקרת גרסאות של ממשק ה-API. בקיצור, לממשקי API יש גרסאות, ולשרתי proxy של API יש תיקונים.