Notice: We're retiring Works with Nest. See the home page for more information.
Google is committed to advancing racial equity for Black communities. See how.
דף זה תורגם על ידי Cloud Translation API.
Switch to English

הפניה לאישור

בקשת קוד הרשאה

בהתאם לסוג הבקשה, אנו מיישמים אורך קוד שונה וערכי TTL (Time-to-Live):

זְרִימָה TTL אורך הקוד
רשת 10 דקות 16 תווים
פִּין 48 שעות 8 תווים

פרמטרים

פרמטרי ההרשאה הנתמכים ב- API של Nest הם:

שֵׁם סוּג נדרש תיאור
client_id חוּט כן זמין בדף לקוחות OAuth.
redirect_uri חוּט לא השתמש בזה כדי לציין את ה- URI להפניה הרצויה אם קביעת תצורה של קבצי URI להפניה מרובים עבור הלקוח שלך. השמיט אותו כדי להשתמש ב- URI ברירת המחדל להפניה מחדש.

אל תכלול פרמטרים אחרים בפרמטר redirect_uri עצמו, הוא אמור להתאים ל- URI להפניה מחדש שהוגדר עבור הלקוח שלך בדיוק.
state חוּט כן השתמש בזה כדי לציין ערך לא ניתן לנחש למאבק בהתקפות CSRF . אחרת, השתמש בערך ברירת המחדל של STATE .

הודעות שגיאה המבוססות על קוד PIN

ניתן להציג את הודעות השגיאה שלהלן למשתמשים במהלך בקשות קוד הרשאה מבוססות PIN:

הודעת שגיאה של משתמש הֶסבֵּר
חסר מזהה לקוח או פרמטרי מצב. בכתובת האתר של ההרשאה חסר פרמטר client_id או state , או שניהם. ודא שכתובת האתר של ההרשאה הושלמה ומדויקת.
אופס! נתקלנו בשגיאה. בבקשה נסה שוב. שגיאה זו מתרחשת מהדברים הבאים:
  • שירות הקן מושבת. המתן עד לשחזור שירות הקן.
  • לקוח אינו קיים עבור client_id הנתון. ודא שכתובת האתר להרשאה שהועברה משתמשת ב- client_id הנכון.
החיבור לשם חברה אינו זמין כרגע. אנא צרו קשר עם קן למידע נוסף. הלקוח חרג ממכסת המשתמש. הגש את הלקוח שלך לבדיקה כדי להוסיף משתמשים נוספים.

הפנה מחדש את תגובות השגיאה המבוססות על URI

לכל התגובות, סוג התוכן: application/json .

חסרים פרמטרים נדרשים

פרטים
קוד סטטוס HTTP בקשה שגויה 400
גוּף {
"error":"oauth2_error",
"error_description":"missing required parameters: PARAM_NAME "
}
הֶסבֵּר פרמטר חובה, PARAM_NAME , חסר בבקשת קוד ההרשאה.

redirect_uri לא נרשם מראש

פרטים
קוד סטטוס HTTP בקשה שגויה 400
גוּף {
"error":"input_data_error",
"error_description":"redirect_uri not pre-registered"
}
הֶסבֵּר הפרמטר redirect_uri המשמש בבקשת אסימון הגישה אינו תואם לאף אחד מה- URI להפניה מחדש שהוגדר עבור הלקוח שלך.

בקשת אסימון גישה

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

בקשת אסימון הגישה היא בצורה של בקשת HTTP POST.

פרמטרים

שֵׁם סוּג נדרש תיאור
code חוּט כן קוד ההרשאה שמועבר לאחר שהלקוח שלך מסכים לתת לאפליקציה שלך גישה לנתוני Nest. ערך זה מסופק על ידי בקשת קוד הרשאה מוצלחת.

למד כיצד להגדיר הרשאה
client_id חוּט כן זמין בדף לקוחות OAuth.
client_secret חוּט כן זמין בדף לקוחות OAuth; עשוי להיקרא גם מפתח יישום.
grant_type חוּט כן חייב להיות מחרוזת זו: authorization_code

תְגוּבָה

לכל התגובות, סוג התוכן: application/json

קוד סטטוס HTTP תיאור גוּף
200 אישור אסימון הגישה מוחזר. השתמש באסימון הגישה בשיחות לשירות הקן. LONG הוא מספר השניות עד שתוקף האסימון פג. {
"access_token":"STRING",
"expires_in":LONG
}

גישה לכל החיים אסימון

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

גישה לתגובות שגיאה לאסימון

לכל התגובות, סוג התוכן: application/json .

פג תוקף ההרשאה

פרטים
קוד סטטוס HTTP בקשה שגויה 400
גוּף {
"error":"oauth2_error",
"error_description":"authorization code expired"
}
הֶסבֵּר תוקף קוד ההרשאה פג. דרוש קוד הרשאה חדש כדי לבקש אסימון גישה.

קוד ההרשאה לא נמצא

פרטים
קוד סטטוס HTTP בקשה שגויה 400
גוּף {
"error":"oauth2_error",
"error_description":"authorization code not found"
}
הֶסבֵּר פרמטר code אינו חוקי. בדוק שאתה משתמש בקוד ההרשאה הנכון.

הלקוח לא פעיל

פרטים
קוד סטטוס HTTP איסור 403
גוּף {
"error":"client_not_active",
"error_description":"client is not active"
}
הֶסבֵּר בדוק שאתה משתמש בפרמטרים הנכונים. אם הפרמטרים נכונים, והשגיאה מתרחשת רק בשיטות הרשאה מסוימות (לדוגמה, הרשאה מצליחה באמצעות Postman, אך לא באמצעות Curl), ייתכן שיש משהו לא בסדר בתחביר שלך.

שגיאה זו מתרחשת גם אם הלקוח שלך מבוטל.

סוד הלקוח לא נמצא

פרטים
קוד סטטוס HTTP בקשה שגויה 400
גוּף {
"error":"oauth2_error",
"error_description":"client secret not found"
}
הֶסבֵּר הפרמטר client_secret אינו חוקי. בדוק שאתה משתמש בערך client_secret הנכון.

חסרים פרמטרים נדרשים

פרטים
קוד סטטוס HTTP בקשה שגויה 400
גוּף {
"error":"oauth2_error",
"error_description":"missing required parameters: PARAM_NAME "
}
הֶסבֵּר פרמטר חובה, PARAM_NAME , חסר בבקשת אסימון הגישה.

הפניה_ורי אסורה

פרטים
קוד סטטוס HTTP בקשה שגויה 400
גוּף {
"error":"input_error",
"error_description":"redirect_uri not allowed"
}
הֶסבֵּר פרמטר redirect_uri שימש בבקשת אסימון הגישה.