בשביל מה מייצג API? דוגמאות לשימוש בממשקי API

API מייצג "ממשק תכנות יישומים". ולמרות שזה אולי נשמע מוזר אם אתה חדש בתכנות, קל להבין אותם ברגע שאתה מפרק את זה. אתה אפילו משתמש בהם מדי יום תוך כדי הפעלת הטלפון הנייד, המחשב האישי שלך או בעת גלישה באינטרנט.

תוכנות, כולל אפליקציות אינטרנט, אפליקציות סלולריות ותוכנות רבות אחרות, מקשרות את העולם באמצעות האינטרנט. אבל כדי להפוך את זה ליעיל יותר, חייב להיות ערוץ תקשורת בין התוכנה הזו - שם נכנס API.

כאן נסביר את המשמעות של ממשקי API וכיצד להשתמש בהם.

מהו API?

האם אתה יודע כיצד אתה מסוגל לראות סרטונים בפלטפורמות סטרימינג כמו נטפליקס ויוטיוב בין היתר? זה אפשרי מכיוון שאתה שולח בקשה דרך ממשק API.

או שדמיינת כיצד תוכל לשלם עבור הסחורה שאתה קונה מחנויות מקוונות כמו אמזון ואיביי? זה גם בגלל שיש ערוץ תקשורת המכונה API בין הבנק שלך לאפליקציות הקניות.

עם זאת, ממשק API הוא ממשק עם מערכת חוקים המאפשרת לשרת האפליקציה שלך לקיים אינטראקציה עם שרת ספק הפתרונות כדי שתוכל להשתמש במשאבים שלהם. בעיקרו של דבר, הוא מגדיר כיצד אפליקציות או תוכנות מתקשרים זה עם זה.

אולם במקרים מסוימים ממשק API מאפשר חילופי נתונים הדדיים. דוגמה לכך היא חיבור שקיים בין אפליקציות הבנק שלך לאפליקציות של חנויות מקוונות.

API הוא כמו שליח. הוא מתחבר לשרת של ספק בקצה אחד וגם מעגן את שרת הלקוח בקצה השני. לאחר מכן הוא מכרז את בקשת הלקוח למקור הנתונים (שרת הספק) ומחזיר תגובה ללקוח. לקוח כאן הוא הדפדפן או האפליקציה שלך.

וו, לעומת זאת, מצרף את האפליקציה שלך ל- API. זו נקודת סיום של API. עם זאת, הרבה דברים נפרשים מאחורי הסצנה. נסביר זאת בהמשך.

כיצד ממשקי API עוזרים לך לפתח אפליקציות מהר יותר

ממשקי API הם כלי חכם יותר לבניית יישומים חלקים וחזקים. בלעדיהם בניית אפליקציות מתוחכמות תארך עידנים.

דמיין שאתה זקוק לאפליקציה שלך כדי לבצע פעולות מורכבות, מהסוג שלוקח המון זמן ומאמץ לבנות. ואז מישהו מופיע עם תוכנית מוכנה שעושה בדיוק מה שאתה רוצה, ואולי טוב יותר.

אבל איך אתה יכול לחבר את זה לאפליקציה שלך? הספק, שהבין שזה עשוי לתת לך קצת זמן קשה, ואז אמר לך שהוא יצר ממשק חיבור (API) שגורם לקוד שלך לשלך להשתלב בצורה חלקה.

ממשק זה (API) מתחבר לשרת המכיל את הקוד שלהם. ואז זה מחזיר לך את הנתונים הרלוונטיים מפעולת התסריט שלהם.

כמובן, אתה לא רוצה לשעמם את כל תסריט המקור שלהם. חוץ מזה, רוב ממשקי ה- API המודרניים מסתמכים כעת על טכנולוגיית REST (Representational State Transfer) סטנדרטית. זה הופך אותם להרחבה מאוד וקלים לשילוב, מבלי שתצטרכו לדאוג למה שמתרחש בתוך המצב או למצב התגובה או הבקשה שלכם בזמן שהם מעוצבים מראש.

מאמר זה לא ימשיך להסביר את REST API. דגש על היסודות לעת עתה.

לחבר את הקוד שלך לקודם זה רעיון טוב יותר מאשר לכתוב אותו מאפס. לשם כך, עם זאת, עליך לחבר את הקוד שלך לממשק ה- API שהם סיפקו. איך אתה עושה את זה? זה המקום שבו נקודת סיום של API נכנסת לזירה.

מהו נקודת סיום של API?

כדי לפשט את העניינים, הספקים מעלים כתובת URL כדי להתחבר לממשק ה- API שלהם בצורה חלקה. כתובת URL כזו היא נקודת סיום API. באמצעותה, האפליקציה שלך יכולה לגשת לשרת שלהם דרך ה- API ולתקשר ישירות עם הסקריפט שלהם.

אז כל מה שאתה צריך לעשות זה לתפוס את נקודת הקצה, להדביק אותה בקוד שלך, להגיש איתה בקשות, להתאים אישית את התגובות ואז זה עובד, וזה שלך! נקודת סיום של API, מחברת את האפליקציה שלך באמצעות API לפיתרון או למקור נתונים.

בסופו של דבר, רבות מהתוכניות המציעות ממשקי API זמינות בשפות תכנות שונות, כך שאף אחד לא נשלל להפיק תועלת מהן.

בדרך זו, אתה מקבל קוד מהיר ויעיל יותר, בידיעה שחובת האחזקה של ה- API אינה עליך אלא ספקי הנתונים או הפתרונות.

לכן, נקודת קצה של API היא וו תקשורת הקושר API לשרת משאבים בקצה אחד ומחבר אותו לשרת המקלט בצד השני.

המשמעות היא שאינך זקוק לכל הסקריפט של הפתרון שבו ברצונך להשתמש. אך הקוד שלך לא יכול ליצור עמו תקשורת אם הוא לא מתחבר לנקודת הקצה של ה- API שלו.

כללי שילוב API

אין כלל קשה לשילוב API. יש המון כאלה שם בחוץ, ולכל אחד מהם כללי האינטגרציה שלו. אבל זכור שאתה מצפה ל תְגוּבָה בכל פעם שאתה יוצר חיבור עם API.

האופן שבו אתה מגיש בקשות באמצעות נקודת קצה של API מבוסס בדרך כלל על כללים המוגדרים על ידי ספק, אך מה שאתה עושה עם התגובה שתקבל תלוי בהעדפתך. בעיקרו של דבר, אתה יכול לסובב את זה כמו שאתה רוצה להתאים לחוויה של המשתמשים ובממשק המשתמשים שלך.

לפעמים אתה צריך גם מאמת לפני שתוכל לגשת ל- API. מאמתים כאלה מגיעים בדרך כלל כאסימוני גישה או כמפתחות API. לאחר שהאסימון הזה עובר בדיקת אימות, ה- API אז מאותת על נקודת הקצה שלו כדי ליצור חיבור בין האפליקציה שלך לשרת הספק.

כצרכן ה- API, אינך צריך לדאוג לפרמטרים אלה מכיוון שספק ה- API הופך אותם לזמינים. ממשק API מצוין צריך לציין כיצד ניתן לגשת למשאבים שלו ולהשתמש בהם בתיעוד שלו. אז תמיד יש להיזהר מכך כשמנסים לשלב אחד כזה.

כדי לסכם את זה, שיחת API היא כולה כותרות, an נקודת סיום, ה בַּקָשָׁה, וה תְגוּבָה או ה גוּף.

בעוד שהסברנו מהי נקודת קצה, בואו נפרוט את המונחים האחרים הבאים:

כותרות

בדרך כלל, עליך לתאר שתי צורות של כותרות בעת התחברות ל- API: ה- בַּקָשָׁה וה תְגוּבָה כותרות.

ה כותרת בקשה הוא השער של שיחת API. זה מתאר את הגישה של הלקוח לגישה למשאב. זה עשוי לפרט על דברים כמו סוג חיבור מקובל, מידע proxy וסוג הנתונים (JSON, XML או HTML) שאתה רוצה לקבל מממשק ה- API.

כפי שתיארנו קודם, תלוי בסוג ה- API שאליו אתה מתחבר, ייתכן שיהיה עליך לספק אסימון אימות ייחודי גם בתוך כותרת הבקשה. הספק בדרך כלל נותן זאת.

ה כותרת תגובה, לעומת זאת, היא קביעה של הנתונים שמגיעים משרת הספק. זה נותן לאפליקציה שלך מידע על מאפייני הספק. למעשה, זה מבטיח שהאפליקציה שלך תעניק גישה לתגובה שמגיעה ממשק ה- API.

בקשת API

בקשת API מכילה בדרך כלל את נקודת הקצה בכתובת אתר (Unique Resource Locator). הוא משתמש בפרוטוקול Hypertext Transfer Protocol (HTTP) כדי לאתר את כתובת המשאב אליו אתה מנסה לגשת באמצעות API. בסופו של דבר, בקשת API אינה שלמה אם אינך כולל את נקודת הקצה בכתובת האתר.

תגובת API

תשובה היא מה ש- API שולח בחזרה בכל פעם שהוא מקבל בקשה מהאפליקציה שלך. זה יכול להיות JSON, XML או HTML, תלוי בנתונים או בסוג התוכן שהוא מקבל מכותרת הבקשה שלך.

ברגע שתקבל תשובה מממשק API, תוכל לשקול שיחת API שלך בהצלחה.

אופן השימוש בממשקי API: דוגמאות מעשיות

עכשיו שאתה יודע את היסודות של ממשקי API ומה אתה צריך כדי לשלב אחד מהם. בדוק כיצד להתחבר ולשלב ממשק API לחיזוי כדורגל RapidAPI באמצעות פייתון למטה.

זו שיחת API פשוטה שמחזירה תגובת JSON. אתה יכול גם לכתוב את הקוד שלך כל עורך טקסטים, והפעל אותו דרך שורת הפקודה.

קָשׁוּר: כיצד להפעיל את סקריפט הפיתון שלך

עם זאת, שים לב לנקודת הסיום, לתוכן של כותרות הבקשה וכותרות התגובה:

בקשות ייבוא
נקודת קצה = " https://football-prediction-api.p.rapidapi.com/api/v2/predictions"
queryparams = {"market": "classic", "iso_date": "2021-01-01", "federation": "UEFA"}
# הגדר את כותרת הבקשה:
כותרות = {
'x-rapidapi-key': "הדבק כאן את מפתח הגישה שלך",
'x-rapidapi-host': "football-prediction-api.p.rapidapi.com"
}
# הגדר את כותרת התגובה:
response = requests.request ("GET", נקודת קצה, כותרות = כותרות, params = queryparams)
# קבל את התגובה:
הדפס (תגובה.טקסט)

תמשיך ללמוד: כיצד להשתמש ב- IPStack API לחיפושי מיקום גיאוגרפי IP

מה דעתך לקבל את הטמפרטורה והלחות הנוכחיים של מקום באמצעות ממשק API של Weatherstack עם פייתון? להלן דוגמה למטה:

בקשות ייבוא
נקודת קצה = ' http://api.weatherstack.com/current'
כותרות = {
"access_key": "הדבק את מפתח הגישה שלך כאן",
"query": "California"
}
req = requests.get (נקודת קצה, כותרות)
res = req.json ()
הדפס (u "הטמפרטורה הנוכחית ב-% s היא% d ℃"% 
(res ["location"] ["name"], res ["current"] ["temperature"]))
הדפס (u "לחות נוכחית ב-% s היא% d ℃"% 
(res ["location"] ["name"], res ["current"] ["לחות"]))

סוגי ממשקי API שתוכלו לשלב

ממשקי API של קוד פתוח הם בחינם, וכל אחד יכול להשתמש בהם. ממשקי API פנימיים נמצאים בארגון, ורק אפליקציות השייכות לארגון זה יכולות להשתמש במשאבים שלו.

עם זאת, תוכל גם לבחור ב- API ייעודי על ידי כניסה להסכם שותפות עם ספק. לחלופין, תוכל לשלב מספר ממשקי API כדי לפתור בעיות שונות.

כמו כן, ממשקי API אלה, למעט ממשקי API פתוחים וקוד פתוח, עשויים להיות במחיר שלעתים נע בין מאות לאלפי דולרים.

לפשט את פיתוח האפליקציות בעזרת ממשקי API

כפי שאתה יכול לראות, אתה לא צריך לכתוב קוד יותר זמן. אם אתה זקוק לאפליקציה שלך כדי לבצע פעולות מורכבות, אתה תמיד יכול לחפש שם ולקחת ממשק API רלוונטי. למרבה המזל, הם אפילו קלים יותר לשילוב מאשר קונבנציונאלי ישן. ואם אתה סקרן ורוצה לדעת יותר, ישנם ממשקי API רבים בחינם שיכולים לעזור לך ללכלך את הידיים.

כיצד ממשקי API עובדים וכיצד לשלב אותם באפליקציה שלך

שימוש בממשקי תכנות יישומים (API) הוא מיומנות חיונית לכל המתכנתים לשלוט בהם.

קרא הבא

על הסופר