‏ברוכים הבאים

בקשת ה-API הראשונה שלך ב״קיצורים״

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

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

בניית בקשת ה-API

נקודת הקצה של תחזית Dark Sky דורשת כי בקשת כתובת אינטרנט תהיה במבנה הבא:

‪https://api.darksky.net/forecast/[הקוד_הסודי_שלך]/[רוחב],[אורך]‬

המלל בסוגריים ימולא בקוד API ובמיקום שלגביו תרצה/י נתוני תחזית.

ביישום ״קיצורים״, מקם/י את קוד ה-API מה-Dark Sky בפעולת ה״מלל״ הראשונה, המועברת אל הפעולה ״כתובת אינטרנט״ כמשתנה. הערכים LAT ו-LONG מוגדרים כבר ל-37.8267 ול-122.4233-, הקואורדינטות לאי אלקטרז בסן-פרנסיסקו. (ניתן לשנות את הערכים האלה למיקום אחר.)
נסה/י להשתמש בפעולה ״קבל מיקום נוכחי״ ולמקמה כש״משתנה קסם״ מוגדר ל״קו רוחב״ ו״קו אורך״ בפעולת כתובת האינטרנט על-מנת לקבל נתוני מזג אוויר מקומי בכל הפעלה של הקיצור.

ביצוע בקשת ה-API באמצעות הפעולה ״קבל תוכן של כתובת אינטרנט״

בעורך הקיצורים ביישום ״קיצורים״, הגדר/י את ״קבל תוכן של כתובת אינטרנט״ כ״מתקדם״.
האפשרויות הבאות עבור סוגי בקשות ה-API שביכולתך לבצע הופכות לזמינות:
- הפעולה GET מאפשרת לאחזר נתונים.
- ‏POST מאפשרת לך ליצור נתונים חדשים.
- הפעולה PUT מאפשרת לעדכן נתונים על ידי החלפתם.
- הפעולה PATCH מאפשרת לעדכן נתונים על ידי שינוי שלהם.
- ‏DELETE מאפשרת לך להסיר אובייקט שצוין בבקשת ה-URL.
עבור דוגמה זו, השתמש/י בבקשת GET לאחזור נתונים מה-API של Dark Sky.
כעת כשפעולת כתובת האינטרנט קיבלה את בקשתך והפעולה ״קבל תוכן של כתובת אינטרנט״ מוגדרת לנתוני GET, הינך מוכן/ה לבצע בקשת API.
הערה: כשהפעולה ״קבל תוכן של כתובת אינטרנט״ עוברת ל-POST,‏ PUT או PATCH, מתווסף פרמטר חדש בשם ״גוף בקשה״. ״גוף בקשה״ מאפשר לך לשלוח JSON, טופס או קובץ ל-API כחלק מבקשתך. פעולה זו מאפשרת לך להכניס נתונים חדשים באופן ידני או על-ידי שימוש במשתנים כך שניתן לשלוח את הנתונים ל-API ליצירה, להחלפה או לשינוי של רשומה.
הקש/י על על-מנת לבדוק את הקיצור (הפעולה ״הצצה מהירה״ בקיצור מאפשרת לך להציג בתצוגה מקדימה את הנתונים המוחזרים על-ידי ה-API).
במבט ראשון, נראה כי ה-API מחזיר מלל מבולגן. נתוני מזג אוויר אלה מקודדים ב-JSON, ראשי תיבות של JavaScript Object Notation.

על-מנת לקבל מידע נוסף בנושא עבודה עם JSON ולהמשיך עם דוגמת ה-API של Dark Sky, ראה/י מבוא לשימוש בקובץ JSON ב״קיצורים״.

מועיל?

המדריך למשתמש/ת ב״קיצורים״

בקשת ה-API הראשונה שלך ב״קיצורים״

בניית בקשת ה-API

ביצוע בקשת ה-API באמצעות הפעולה ״קבל תוכן של כתובת אינטרנט״