התחבר לממשקי API ללא קוד: 8 שלבים

2024 מְחַבֵּר: John Day | [email protected]. שונה לאחרונה: 2024-01-30 09:12

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

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

הבאנו חבר כדי להפוך את המסע להרבה יותר קל.

הכירו את סלאש

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

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

שלב 1: החליט איזה API אתה צריך

איזה מידע אתה מחפש או שאתה רוצה לשנות?

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

אם אתה כבר מכיר את האתר או ה- API שאליו אתה מנסה להתחבר, עבור ישירות לשלב 2. אם אתה מנסה למצוא נתונים, אך אינך בטוח היכן להתחיל, Google היא החבר שלך. חפש את "[דברים שאתה מעוניין בהם] API" וראה מה עולה. אתה עשוי להיות מופתע כמה מידע יש שם.

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

שלב 2: מצא את מסמכי ה- API

APIs המסופקים על ידי חברות ידועות צריכים לכלול תיעוד יסודי כיצד להשתמש בהם.

כדי למצוא אותם, חפש בגוגל "תיעוד API [הכנס חברה] או" מפתח [הכנס חברה] ".

התוצאות אמורות להביא אותך לפורטל המפתחים. חפש קישור שאומר "Docs", "Documentation", "Reference" או "Reference Technical".

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

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

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

שלב 3: מצא את נקודת הסיום

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

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

slashtheapidog.com/api/bones/{id}

או רק

/עצמות

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

מתוך המסמכים שלו, אלה הם נקודות הסיום ב- API של Slash הקשורות לחורים:

קבל

קבל

POST

PUT

POST

שלב 4: קבע את סוג הבקשה שלך

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

ישנם 4 סוגים שונים של בקשות:

לקבל

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

הודעה

בקשת POST היא האופן שבו אתה אומר ל- API ליצור משהו חדש. הדבר דומה לבקש מ- Slash לחפור (ליצור) חור חדש עבורך.

לָשִׂים

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

לִמְחוֹק

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

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

שלב 5: הבנת הפרמטרים

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

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

פרמטרי ה- API של Slash עשויים להיראות בערך כך לאחזור כדורים:

קבל

שלב 6: פרמט את הבקשה שלך

יש לנו את כל המידע הדרוש לנו, עכשיו רק נצטרך להגיש את הבקשה!

להלן שתי דרכים שונות להתחבר לממשק API שאינו דורש קוד. בואו להתחבר ל- API של Slash כדי לקבל את רשימת הכדורים שלו על ידי בקשת GET ל-

פרבולה - אם ברצונך להתחבר ולעבוד עם נתונים ללא קוד

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