הפניית API ל-JavaScript ל-reCAPTCHA

בדף הזה מוסבר על השיטות של reCAPTCHA JavaScript API ועל פרמטרי ההגדרה שלהן, שאפשר להשתמש בהן כדי לעבד את דפי האינטרנט עם מפתח reCAPTCHA (מפתח אתר).

שיטות של reCAPTCHA JavaScript API

בקטע הזה מתוארים התחביר והפרמטרים של שיטות reCAPTCHA JavaScript API.

grecaptcha.enterprise.render

הפונקציה מעבדת את הקונטיינר כווידג'ט reCAPTCHA ומחזירה את המזהה של הווידג'ט החדש שנוצר.

תחביר

grecaptcha.enterprise.render(container: string | HTMLelement, parameters: Object): number

פרמטרים של שיטה

פרמטר	תיאור
container	רכיב ה-HTML שבו יוצג הווידג'ט של reCAPTCHA. מציינים את המזהה של מאגר התגים (מחרוזת) או את רכיב ה-DOM עצמו.
parameters	אובייקט שמכיל פרמטרים כצמדי מפתח=ערך, לדוגמה, {"sitekey": "your_site_key", "action": "login", "theme": "dark"}. פרטים על כל פרמטר שאפשר להגדיר מופיעים במאמר מאפיינים ופרמטרים.

הערך שמוחזר

הפונקציה מחזירה את המזהה של הווידג'ט החדש שנוצר.

grecaptcha.enterprise.reset

מאפס את הווידג'ט של reCAPTCHA.

תחביר

grecaptcha.enterprise.reset(widget_id: number): void

פרמטרים

פרמטר	תיאור
widget_id	זה שינוי אופציונלי. מזהה הווידג'ט שהוחזר מ-grecaptcha.enterprise.render(). אם לא מציינים את המזהה, ברירת המחדל היא המזהה של הווידג'ט הראשון שנוצר.

הערך שמוחזר

הפונקציה לא מחזירה ערך.

grecaptcha.enterprise.execute

הפעלת האימות מסוג reCAPTCHA באופן אוטומטי.

תחביר

grecaptcha.enterprise.execute(widget_id: number): Promise<string>

grecaptcha.enterprise.execute(sitekey: string, action: Object): Promise<string>

פרמטרים

פרמטר	תיאור
widget_id	זה שינוי אופציונלי. מזהה הווידג'ט שהוחזר מ-grecaptcha.enterprise.render(). אם לא מציינים את המזהה, ברירת המחדל היא המזהה של הווידג'ט הראשון שנוצר. הערה: לשימוש עם מפתחות אתר של תיבות סימון.
sitekey	מציינים את מפתח האתר של reCAPTCHA שרוצים להגן עליו. הערה: לשימוש עם מפתחות אתר שמבוססים על ניקוד.
action	אובייקט עם צמד מפתח=ערך יחיד, שבו הערך של המפתח action מציין את שם הפעולה שמשויכת לאלמנט המוגן. הערה: לשימוש עם מפתחות אתר שמבוססים על ניקוד. לדוגמה: {"action": "action_name"}

הערך שמוחזר

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

grecaptcha.enterprise.ready

הפונקציה מופעלת כשהספרייה של reCAPTCHA JavaScript נטענת.

תחביר

grecaptcha.enterprise.ready(callback: function): void

פרמטרים

פרמטר	תיאור
callback	הפונקציה שאליה מתבצעת קריאה כשטעינת ספריית reCAPTCHA מסתיימת.

הערך שמוחזר

הפונקציה לא מחזירה ערך.

grecaptcha.enterprise.getResponse

מקבל את התשובה לווידג'ט reCAPTCHA.

תחביר

grecaptcha.enterprise.getResponse(widget_id: number): string

פרמטרים

פרמטר	תיאור
widget_id	זה שינוי אופציונלי. מזהה הווידג'ט שהוחזר מ-grecaptcha.enterprise.render(). אם לא מציינים את המזהה, ברירת המחדל היא המזהה של הווידג'ט הראשון שנוצר.

הערך שמוחזר

מקבל את התגובה של הווידג'ט reCAPTCHA. יכול להיות שזה מחרוזת עם הטוקן שנוצר על ידי grecaptcha.enterprise.execute() או מחרוזת ריקה אם הטוקן עדיין לא נוצר.

הגדרות אישיות

בקטע הזה מוסבר על פרמטרים של משאבי JavaScript ועל הפרמטרים שבהם משתמשים ב-grecaptcha.enterprise.render() ועל מאפיינים של הווידג'ט g-recaptcha.

פרמטרים של משאב JavaScript ‏ (enterprise.js)

בטבלה הבאה מפורטים הפרמטרים של משאב JavaScript ‏ (enterprise.js) שחובה לכלול כשמשתמשים ב-reCAPTCHA.

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

פרמטר	ערך	תיאור
onload	callback	זה שינוי אופציונלי. השם של פונקציית הקריאה החוזרת שתופעל אחרי שכל התלויות ייטענו.
render	onload	אופציונלי, ערך ברירת מחדל. הווידג'ט מוצג בתג g-recaptcha הראשון שנמצא. הערה: לשימוש עם מפתחות אתר של תיבות סימון.
	explicit	זה שינוי אופציונלי. הווידג'ט לא מוצג באופן אוטומטי. צריך להתקשר אל grecaptcha.enterprise.render() כדי להציג אותו באופן פרוגרמטי. הערה: לשימוש עם מפתחות אתר של תיבות סימון.
	siteKey	כשמשתמשים בפרמטר הזה עם מפתחות אתר שמבוססים על ניקוד, הוא לא אופציונלי. הערך siteKey מציין את מפתח האתר שמבוסס על ניקוד שמשויך. הערה: לשימוש רק עם מפתחות אתר מבוססי-ניקוד. אם משתמשים בו עם מפתחות אתר של תיבת סימון, הסקריפט לא ייטען.
hl	קודים של שפות	זה שינוי אופציונלי. הפרמטר הזה מאלץ את הווידג'ט לעבור עיבוד בשפה ספציפית. אם לא מציינים שפה, המערכת מזהה אוטומטית את השפה של המשתמש.

מאפייני התג g-recaptcha ופרמטרים של grecaptcha.enterprise.render()‎

בטבלה הבאה מפורטים מאפייני התג g-recaptcha והפרמטרים התואמים grecaptcha.enterprise.render().

מאפיין של תג g-recaptcha	פרמטר grecaptcha.enterprise.render()	ערכים מותרים	ברירת מחדל	תיאור
data-sitekey	sitekey			מפתח reCAPTCHA.
data-badge	badge	bottomright, bottomleft, inline	bottomright	זה שינוי אופציונלי. שינוי המיקום של תג reCAPTCHA. inline מאפשרת למקם אותו באמצעות CSS.
data-action	action			זה שינוי אופציונלי. מחרוזת שמתארת את הפעולה הנוכחית.
data-theme	theme	dark, light	light	זה שינוי אופציונלי. ערכת הצבעים של הווידג'ט.
data-size	size	compact, normal	normal	זה שינוי אופציונלי. גודל הווידג'ט.
data-tabindex	tabindex	מספר שלם	0	זה שינוי אופציונלי. הערך של tabindex של הווידג'ט והאתגר. אם יש בדף רכיבים אחרים שמשתמשים ב-tabindex, צריך להגדיר אותו כך שהניווט יהיה קל יותר למשתמשים.
data-callback	callback	String	לא רלוונטי	זה שינוי אופציונלי. השם של פונקציית הקריאה החוזרת (callback), שמופעלת כשהמשתמש שולח תגובה מוצלחת. הטוקן g-recaptcha-response מועבר לקריאה החוזרת.
data-expired-callback	expired-callback	String	לא רלוונטי	זה שינוי אופציונלי. השם של פונקציית הקריאה החוזרת, שמופעלת כשתוקף התשובה של reCAPTCHA פג והמשתמש צריך לאמת מחדש.
data-error-callback	error-callback	String	לא רלוונטי	זה שינוי אופציונלי. השם של פונקציית הקריאה החוזרת, שמופעלת כש-reCAPTCHA מזהה שגיאה (בדרך כלל קישוריות לרשת) ולא יכול להמשיך עד שהקישוריות משוחזרת. פונקציית ה-callback לא מקבלת ארגומנטים שמכילים פרטים על השגיאה. אם מציינים כאן פונקציה, אתם אחראים להודיע למשתמש שעליו לנסות שוב.