הגדרת Time Zone API

במסמך הזה מתוארים השלבים שצריך לבצע כדי להתחיל להשתמש ב-Time Zone API.

דרישות מוקדמות

כאן נסביר איך מגדירים חשבון Google Cloud ופרויקט בענן ב-Google Cloud עם חיוב מופעל. כדאי גם להכיר את אופן החיוב על השימוש ב-Time Zone API.

1. בודקים את החיוב והעלות של השימוש ב-Time Zone API Usage and Billing.

2. מוודאים שיש לכם חשבון Google Cloud.

   נכנסים למסוף Google Cloud
   הערה: אם אתם משתמשים חדשים ואין לכם חשבון Google Cloud, כלומר אתם לא יכולים להיכנס למסוף, קראו את המאמר תחילת השימוש ב-Google Maps Platform.

3. מוודאים שיש לכם פרויקט ב-Google Cloud שהחיוב מופעל בו.

   כניסה לדף Billing
   הערה: אם אתם משתמשים חדשים ואין לכם פרויקט ב-Google Cloud, קראו את המאמר תחילת השימוש בפלטפורמה של מפות Google.
1. בוחרים את הפרויקט כדי לפתוח את הדף Billing.

2. בדף Billing:

   • אם החיוב כבר מופעל בפרויקט שנבחר ויש לכם רק חשבון לחיוב אחד, ייפתח הדף Billing.
   • אם יש לכם כמה חשבונות לחיוב, לוחצים על Go to linked billing account כדי לראות את הפרטים של החשבון לחיוב שמשויך לפרויקט.
   • אם קיים חשבון לחיוב אבל הוא לא משויך לפרויקט, תתבקשו לקשר חשבון לחיוב לפרויקט.
   • אם אין חשבון לחיוב או שרוצים ליצור חשבון חדש, בוחרים באפשרות Manage Billing Accounts כדי ליצור חשבון חדש לחיוב. למידע נוסף, קראו את המאמר איך יוצרים חשבון חדש לחיוב ב-Cloud בשירות עצמי.

הפעלת ה-API

כדי להשתמש ב-Time Zone API, צריך להפעיל אותו בפרויקט ב-Google Cloud באמצעות מסוף Google Cloud או הפקודה gcloud.

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

כדי להפעיל את ה-API:

המסוף

1. פותחים את דף המוצר במסוף Google Cloud:

   הפעלת Time Zone API

2. לוחצים על הכפתור הפעלה.

   הערה: אם ה-API כבר מופעל, הלחצן Manage מופיע במקום Enable.

gcloud

gcloud services enable \
    --project "PROJECT" \
    "timezone-backend.googleapis.com"

מידע נוסף על Google Cloud SDK, התקנת Cloud SDK והפקודות הבאות:

• gcloud services enable
• gcloud services disable

קבלת מפתח API לשימוש עם Time Zone API

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

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

המסוף

1. נכנסים לדף Google Maps Platform > Keys & Credentials.

   כניסה לדף Keys & Credentials

2. אם מתבקשים, בוחרים את הפרויקט.

3. מבצעים אחת מהפעולות האלה:

   • יצירת מפתח חדש:

     1. לוחצים על Create credentials > מפתח API.
     2. בחלונית יצירת מפתח API, פותחים את הרשימה בחירת הגבלות API.
     3. מבטלים את הבחירה בכל ממשקי ה-API שהמפתח הזה לא צריך, ומוודאים שהאפשרות Time Zone API נשארת מסומנת.
     4. לוחצים על יצירה. בחלונית מוצג מפתח ה-API החדש.

   • שימוש במפתח קיים:

     1. לוחצים על שם המפתח.
     2. ברשימה Select API restrictions, בוחרים באפשרות Time Zone API.
     3. לוחצים על שמירה.

   בחירת API כאן לא מפעילה אותו. מוודאים ש-Time Zone API מופעל בדף API Library שלו.

4. כדי לראות את מחרוזת המפתח מאוחר יותר, עוברים לדף Keys & Credentials ולוחצים על Show key ליד המפתח.

אם המסוף נראה שונה מהשלבים האלה, עיינו במאמרים יצירת מפתח API והוספת הגבלות על API במסמכי התיעוד של Google Cloud.

gcloud

בפקודות הבאות, מחליפים את PROJECT_ID במזהה הפרויקט.

• יצירת מפתח חדש: מריצים את הפקודה הבאה ומחליפים את DISPLAY_NAME בשם של המפתח.

  gcloud services api-keys create \
      --project="PROJECT_ID" \
      --display-name="DISPLAY_NAME" \
      --api-target=service=timezone-backend.googleapis.com

  מידע נוסף על Google Cloud SDK, התקנת Cloud SDK והפקודות הבאות:

  • gcloud services api-keys create

• שימוש במפתח קיים: מריצים את הפקודה הבאה ומחליפים את KEY_ID במזהה המפתח. הדגל --append שומר על ממשקי ה-API שהמפתח כבר מאפשר. בלעדיו, הפקודה מחליפה אותם.

  gcloud services api-keys update KEY_ID \
      --project="PROJECT_ID" \
      --append \
      --api-target=service=timezone-backend.googleapis.com

  מידע נוסף על Google Cloud SDK, התקנת Cloud SDK והפקודות הבאות:

  • gcloud services api-keys update
  • gcloud services api-keys list

  מזהה המפתח הוא לא מחרוזת המפתח או השם המוצג. כדי למצוא אותו, מריצים את הפקודה gcloud services api-keys list --project="PROJECT_ID". המזהה הוא החלק האחרון בשדה name: projects/PROJECT_NUMBER/locations/global/keys/KEY_ID.

כדי לראות את מחרוזת המפתח, מריצים את הפקודה gcloud services api-keys get-key-string KEY_ID --project="PROJECT_ID".

שליחת בקשת API

שולחים בקשת Time Zone API כדי לקבל תשובה בפורמט JSON שמכילה את פרטי אזור הזמן של נבאדה, ארה"ב. חותמת הזמן מוגדרת ל-5 בדצמבר 2024. בכל בקשה צריך לכלול את המחרוזת האלפאנומרית של מפתח ה-API, ולהשתמש ב-HTTPS בבקשות שכוללות את מפתח ה-API.

1. לוחצים על API_KEY בקוד שבהמשך כדי להוסיף את המחרוזת האלפאנומרית של המפתח:

   curl -L -X GET 'https://maps.googleapis.com/maps/api/timezone/json?location=39.6034810%2C-119.6822510&timestamp=1733428634&key=YOUR_API_KEY'
   

2. לוחצים על סמל ההעתקה בדוגמת הקוד, , כדי להעתיק את הפקודה curl.
3. מדביקים את הפקודה בחלון הטרמינל ומריצים אותה.

התגובה היא אובייקט JSON בפורמט הבא:

{
   "dstOffset" : 0,
   "rawOffset" : -28800,
   "status" : "OK",
   "timeZoneId" : "America/Los_Angeles",
   "timeZoneName" : "Pacific Standard Time"
}

החלת הגבלות על מפתחות API

שימו לב: מפתח API ללא הגבלה יכול לשמש לשליחת בקשה לכל שירות של הפלטפורמה של מפות Google, כולל Time Zone API. אתם אחראים מבחינה כספית לחיובים שנגרמו כתוצאה מניצול לרעה של מפתחות API לא מוגבלים.

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

• הגבלות על ממשקי API מציינות לאילו ערכות SDK וממשקי API אפשר לקרוא באמצעות מפתח ה-API. כשיוצרים מפתח במסוף וב-CLI של gcloud, צריך להגדיר לפחות הגבלה אחת ל-API.
• הגבלות על אפליקציות מציינות אילו כתובות IP, אפליקציות ואתרים יכולים להשתמש במפתח API.

מידע נוסף על הגבלות זמין במאמר הגבלת מפתחות API.

המאמרים הבאים

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