Firebase App Check API

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

שירות: firebaseappcheck.googleapis.com

כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי לקרוא לשירות הזה, השתמשו במידע הבא כשתשלחו את בקשות ה-API.

מסמך הגילוי

מסמך Discovery הוא מפרט קריא למחשבים לתיאור ולשימוש בממשקי API ל-REST. הוא משמש לבניית ספריות לקוח, יישומי פלאגין בסביבת פיתוח משולבת (IDE) וכלים אחרים שיוצרים אינטראקציה עם Google APIs. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמכי הגילוי הבאים:

נקודת קצה בשירות

נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. לשירות אחד יכולות להיות כמה נקודות קצה (endpoints) של שירות. לשירות הזה יש את נקודת הקצה הבאה של השירות, וכל מזהי ה-URI הבאים הם יחסיים לנקודת הקצה של השירות:

  • https://firebaseappcheck.googleapis.com

משאב REST: v1beta.jwks

שיטות
get GET /v1beta/{name}
מחזירה JWK ציבורי שהוגדר על ידי RFC 7517 וניתן להשתמש בו כדי לאמת אסימונים של בדיקת אפליקציה.

משאב REST: v1beta.oauthClients

שיטות
exchangeAppAttestAssertion POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAssertion
מקבל טענת נכוֹנוּת של אפליקציה (assertions) של אפליקציה וארטיפקט (Artifact) שהתקבל בעבר מ-ExchangeAppAttestAttestation ומאמת אותם מול Apple.
exchangeAppAttestAttestation POST /v1beta/{app=oauthClients/*}:exchangeAppAttestAttestation
מקבל אימות (attestation) CBOR של אפליקציה ומאמת אותו מול Apple באמצעות מזהי החבילה והצוות שהוגדרו מראש.
exchangeDebugToken POST /v1beta/{app=oauthClients/*}:exchangeDebugToken
מאמת סוד של אסימון ניפוי באגים שיצרתם בעבר באמצעות CreateDebugToken.
generateAppAttestChallenge POST /v1beta/{app=oauthClients/*}:generateAppAttestChallenge
יוצר אתגר שמגן על התקינות של קריאה מידית ל-ExchangeAppAttestAttestation או ל-ExchangeAppAttestAssertion.

משאב REST: v1beta.projects

שיטות
verifyAppCheckToken POST /v1beta/{project=projects/*}:verifyAppCheckToken
מאמת את האסימון הנתון של בדיקת אפליקציה ומחזיר אותות שימוש באסימון שניתן לפעול לפיהם.

משאב REST: v1beta.projects.apps

שיטות
exchangeAppAttestAssertion POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAssertion
מקבל טענת נכוֹנוּת של אפליקציה (assertions) של אפליקציה וארטיפקט (Artifact) שהתקבל בעבר מ-ExchangeAppAttestAttestation ומאמת אותם מול Apple.
exchangeAppAttestAttestation POST /v1beta/{app=projects/*/apps/*}:exchangeAppAttestAttestation
מקבל אימות (attestation) CBOR של אפליקציה ומאמת אותו מול Apple באמצעות מזהי החבילה והצוות שהוגדרו מראש.
exchangeCustomToken POST /v1beta/{app=projects/*/apps/*}:exchangeCustomToken
מאמת אסימון מותאם אישית שנחתם באמצעות פרטי הכניסה לחשבון השירות של ה-Admin SDK של הפרויקט.
exchangeDebugToken POST /v1beta/{app=projects/*/apps/*}:exchangeDebugToken
מאמת סוד של אסימון ניפוי באגים שיצרתם בעבר באמצעות CreateDebugToken.
exchangeDeviceCheckToken POST /v1beta/{app=projects/*/apps/*}:exchangeDeviceCheckToken
מקבל device_token שהונפק על ידי DeviceCheck, ומנסה לאמת אותו מול Apple.
exchangePlayIntegrityToken POST /v1beta/{app=projects/*/apps/*}:exchangePlayIntegrityToken
מאמת אסימון תגובה לקביעת תקינות מ-Play Integrity.
exchangeRecaptchaEnterpriseToken POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
מתבצע אימות של אסימון תגובה שלreCAPTCHA Enterprise.
exchangeRecaptchaToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaToken
מאמת אסימון תגובה של ReCAPTCHA בגרסה 3.
exchangeRecaptchaV3Token POST /v1beta/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
מאמת אסימון תגובה של ReCAPTCHA בגרסה 3.
exchangeSafetyNetToken
(deprecated)		 POST /v1beta/{app=projects/*/apps/*}:exchangeSafetyNetToken
מאמת אסימון SafetyNet.
generateAppAttestChallenge POST /v1beta/{app=projects/*/apps/*}:generateAppAttestChallenge
יוצר אתגר שמגן על התקינות של קריאה מידית ל-ExchangeAppAttestAttestation או ל-ExchangeAppAttestAssertion.
generatePlayIntegrityChallenge POST /v1beta/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
יוצר אתגר שמגן על התקינות של בקשה לקביעת תקינות שמתרחשת מיד לאחר מכן ל-Play Integrity API.

משאב REST: v1beta.projects.apps.appAttestConfig

שיטות
batchGet GET /v1beta/{parent=projects/*}/apps/-/appAttestConfig:batchGet
מקבלת באופן אטומי את ערכי AppAttestConfig של רשימת האפליקציות שצוינה.
get GET /v1beta/{name=projects/*/apps/*/appAttestConfig}
הפונקציה מקבלת את הערך AppAttestConfig של האפליקציה שצוינה.
patch PATCH /v1beta/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
מעדכנים את AppAttestConfig של האפליקציה שצוינה.

משאב REST: v1beta.projects.apps.debugTokens

שיטות
create POST /v1beta/{parent=projects/*/apps/*}/debugTokens
ייווצר DebugToken חדש לאפליקציה שצוינה.
delete DELETE /v1beta/{name=projects/*/apps/*/debugTokens/*}
מחיקת הערכים שצוינו ב-DebugToken.
get GET /v1beta/{name=projects/*/apps/*/debugTokens/*}
מקבלת את הערך שצוין ב-DebugToken.
list GET /v1beta/{parent=projects/*/apps/*}/debugTokens
בתיבת הדו-שיח הזו מוצגים כל ה-DebugToken של האפליקציה שצוינה.
patch PATCH /v1beta/{debugToken.name=projects/*/apps/*/debugTokens/*}
מתבצע עדכון של DebugToken שצוין.

משאב REST: v1beta.projects.apps.deviceCheckConfig

שיטות
batchGet GET /v1beta/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
מקבלת באופן אטומי את ערכי DeviceCheckConfig של רשימת האפליקציות שצוינה.
get GET /v1beta/{name=projects/*/apps/*/deviceCheckConfig}
הפונקציה מקבלת את הערך DeviceCheckConfig של האפליקציה שצוינה.
patch PATCH /v1beta/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
מעדכנים את DeviceCheckConfig של האפליקציה שצוינה.

משאב REST: v1beta.projects.apps.playIntegrityConfig

שיטות
batchGet GET /v1beta/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
מקבלת באופן אטומי את ערכי PlayIntegrityConfig של רשימת האפליקציות שצוינה.
get GET /v1beta/{name=projects/*/apps/*/playIntegrityConfig}
הפונקציה מקבלת את הערך PlayIntegrityConfig של האפליקציה שצוינה.
patch PATCH /v1beta/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
מעדכנים את PlayIntegrityConfig של האפליקציה שצוינה.

משאב REST: v1beta.projects.apps.recaptchaConfig

שיטות
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/recaptchaConfig:batchGet
מקבלת באופן אטומי את ערכי RecaptchaConfig של רשימת האפליקציות שצוינה.
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/recaptchaConfig}
הפונקציה מקבלת את הערך RecaptchaConfig של האפליקציה שצוינה.
patch
(deprecated)		 PATCH /v1beta/{recaptchaConfig.name=projects/*/apps/*/recaptchaConfig}
מעדכנים את RecaptchaConfig של האפליקציה שצוינה.

משאב REST: v1beta.projects.apps.recaptchaEnterpriseConfig

שיטות
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
מקבלת באופן אטומי את ערכי RecaptchaEnterpriseConfig של רשימת האפליקציות שצוינה.
get GET /v1beta/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
הפונקציה מקבלת את הערך RecaptchaEnterpriseConfig של האפליקציה שצוינה.
patch PATCH /v1beta/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
מעדכנים את RecaptchaEnterpriseConfig של האפליקציה שצוינה.

משאב REST: v1beta.projects.apps.recaptchaV3Config

שיטות
batchGet GET /v1beta/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
מקבלת באופן אטומי את ערכי RecaptchaV3Config של רשימת האפליקציות שצוינה.
get GET /v1beta/{name=projects/*/apps/*/recaptchaV3Config}
הפונקציה מקבלת את הערך RecaptchaV3Config של האפליקציה שצוינה.
patch PATCH /v1beta/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
מעדכנים את RecaptchaV3Config של האפליקציה שצוינה.

משאב REST: v1beta.projects.apps.safetyNetConfig

שיטות
batchGet
(deprecated)		 GET /v1beta/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
מקבלת באופן אטומי את ערכי SafetyNetConfig של רשימת האפליקציות שצוינה.
get
(deprecated)		 GET /v1beta/{name=projects/*/apps/*/safetyNetConfig}
הפונקציה מקבלת את הערך SafetyNetConfig של האפליקציה שצוינה.
patch
(deprecated)		 PATCH /v1beta/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
מעדכנים את SafetyNetConfig של האפליקציה שצוינה.

משאב REST: v1beta.projects.services

שיטות
batchUpdate POST /v1beta/{parent=projects/*}/services:batchUpdate
מתבצע עדכון אטומי של הגדרות Service שצוינו.
get GET /v1beta/{name=projects/*/services/*}
מקבלת את ההגדרות Service עבור שם השירות שצוין.
list GET /v1beta/{parent=projects/*}/services
בתיבת הדו-שיח הזו מפורטים כל ההגדרות של Service לפרויקט שצוין.
patch PATCH /v1beta/{service.name=projects/*/services/*}
ההגדרות שצוינו עבור Service יעודכנו.

משאב REST: v1.jwks

שיטות
get GET /v1/{name}
מחזירה JWK ציבורי שהוגדר על ידי RFC 7517 וניתן להשתמש בו כדי לאמת אסימונים של בדיקת אפליקציה.

משאב REST: v1.projects.apps

שיטות
exchangeAppAttestAssertion POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAssertion
מקבל טענת נכוֹנוּת של אפליקציה (assertions) של אפליקציה וארטיפקט (Artifact) שהתקבל בעבר מ-ExchangeAppAttestAttestation ומאמת אותם מול Apple.
exchangeAppAttestAttestation POST /v1/{app=projects/*/apps/*}:exchangeAppAttestAttestation
מקבל אימות (attestation) CBOR של אפליקציה ומאמת אותו מול Apple באמצעות מזהי החבילה והצוות שהוגדרו מראש.
exchangeCustomToken POST /v1/{app=projects/*/apps/*}:exchangeCustomToken
מאמת אסימון מותאם אישית שנחתם באמצעות פרטי הכניסה לחשבון השירות של ה-Admin SDK של הפרויקט.
exchangeDebugToken POST /v1/{app=projects/*/apps/*}:exchangeDebugToken
מאמת סוד של אסימון ניפוי באגים שיצרתם בעבר באמצעות CreateDebugToken.
exchangeDeviceCheckToken POST /v1/{app=projects/*/apps/*}:exchangeDeviceCheckToken
מקבל device_token שהונפק על ידי DeviceCheck, ומנסה לאמת אותו מול Apple.
exchangePlayIntegrityToken POST /v1/{app=projects/*/apps/*}:exchangePlayIntegrityToken
מאמת אסימון תגובה לקביעת תקינות מ-Play Integrity.
exchangeRecaptchaEnterpriseToken POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaEnterpriseToken
מתבצע אימות של אסימון תגובה שלreCAPTCHA Enterprise.
exchangeRecaptchaV3Token POST /v1/{app=projects/*/apps/*}:exchangeRecaptchaV3Token
מאמת אסימון תגובה של ReCAPTCHA בגרסה 3.
exchangeSafetyNetToken
(deprecated)		 POST /v1/{app=projects/*/apps/*}:exchangeSafetyNetToken
מאמת אסימון SafetyNet.
generateAppAttestChallenge POST /v1/{app=projects/*/apps/*}:generateAppAttestChallenge
יוצר אתגר שמגן על התקינות של קריאה מידית ל-ExchangeAppAttestAttestation או ל-ExchangeAppAttestAssertion.
generatePlayIntegrityChallenge POST /v1/{app=projects/*/apps/*}:generatePlayIntegrityChallenge
יוצר אתגר שמגן על התקינות של בקשה לקביעת תקינות שמתרחשת מיד לאחר מכן ל-Play Integrity API.

משאב REST: v1.projects.apps.appAttestConfig

שיטות
batchGet GET /v1/{parent=projects/*}/apps/-/appAttestConfig:batchGet
מקבלת באופן אטומי את ערכי AppAttestConfig של רשימת האפליקציות שצוינה.
get GET /v1/{name=projects/*/apps/*/appAttestConfig}
הפונקציה מקבלת את הערך AppAttestConfig של האפליקציה שצוינה.
patch PATCH /v1/{appAttestConfig.name=projects/*/apps/*/appAttestConfig}
מעדכנים את AppAttestConfig של האפליקציה שצוינה.

משאב REST: v1.projects.apps.debugTokens

שיטות
create POST /v1/{parent=projects/*/apps/*}/debugTokens
ייווצר DebugToken חדש לאפליקציה שצוינה.
delete DELETE /v1/{name=projects/*/apps/*/debugTokens/*}
מחיקת הערכים שצוינו ב-DebugToken.
get GET /v1/{name=projects/*/apps/*/debugTokens/*}
מקבלת את הערך שצוין ב-DebugToken.
list GET /v1/{parent=projects/*/apps/*}/debugTokens
בתיבת הדו-שיח הזו מוצגים כל ה-DebugToken של האפליקציה שצוינה.
patch PATCH /v1/{debugToken.name=projects/*/apps/*/debugTokens/*}
מתבצע עדכון של DebugToken שצוין.

משאב REST: v1.projects.apps.deviceCheckConfig

שיטות
batchGet GET /v1/{parent=projects/*}/apps/-/deviceCheckConfig:batchGet
מקבלת באופן אטומי את ערכי DeviceCheckConfig של רשימת האפליקציות שצוינה.
get GET /v1/{name=projects/*/apps/*/deviceCheckConfig}
הפונקציה מקבלת את הערך DeviceCheckConfig של האפליקציה שצוינה.
patch PATCH /v1/{deviceCheckConfig.name=projects/*/apps/*/deviceCheckConfig}
מעדכנים את DeviceCheckConfig של האפליקציה שצוינה.

משאב REST: v1.projects.apps.playIntegrityConfig

שיטות
batchGet GET /v1/{parent=projects/*}/apps/-/playIntegrityConfig:batchGet
מקבלת באופן אטומי את ערכי PlayIntegrityConfig של רשימת האפליקציות שצוינה.
get GET /v1/{name=projects/*/apps/*/playIntegrityConfig}
הפונקציה מקבלת את הערך PlayIntegrityConfig של האפליקציה שצוינה.
patch PATCH /v1/{playIntegrityConfig.name=projects/*/apps/*/playIntegrityConfig}
מעדכנים את PlayIntegrityConfig של האפליקציה שצוינה.

משאב REST: v1.projects.apps.recaptchaEnterpriseConfig

שיטות
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaEnterpriseConfig:batchGet
מקבלת באופן אטומי את ערכי RecaptchaEnterpriseConfig של רשימת האפליקציות שצוינה.
get GET /v1/{name=projects/*/apps/*/recaptchaEnterpriseConfig}
הפונקציה מקבלת את הערך RecaptchaEnterpriseConfig של האפליקציה שצוינה.
patch PATCH /v1/{recaptchaEnterpriseConfig.name=projects/*/apps/*/recaptchaEnterpriseConfig}
מעדכנים את RecaptchaEnterpriseConfig של האפליקציה שצוינה.

משאב REST: v1.projects.apps.recaptchaV3Config

שיטות
batchGet GET /v1/{parent=projects/*}/apps/-/recaptchaV3Config:batchGet
מקבלת באופן אטומי את ערכי RecaptchaV3Config של רשימת האפליקציות שצוינה.
get GET /v1/{name=projects/*/apps/*/recaptchaV3Config}
הפונקציה מקבלת את הערך RecaptchaV3Config של האפליקציה שצוינה.
patch PATCH /v1/{recaptchaV3Config.name=projects/*/apps/*/recaptchaV3Config}
מעדכנים את RecaptchaV3Config של האפליקציה שצוינה.

משאב REST: v1.projects.apps.safetyNetConfig

שיטות
batchGet
(deprecated)		 GET /v1/{parent=projects/*}/apps/-/safetyNetConfig:batchGet
מקבלת באופן אטומי את ערכי SafetyNetConfig של רשימת האפליקציות שצוינה.
get
(deprecated)		 GET /v1/{name=projects/*/apps/*/safetyNetConfig}
הפונקציה מקבלת את הערך SafetyNetConfig של האפליקציה שצוינה.
patch
(deprecated)		 PATCH /v1/{safetyNetConfig.name=projects/*/apps/*/safetyNetConfig}
מעדכנים את SafetyNetConfig של האפליקציה שצוינה.

משאב REST: v1.projects.services

שיטות
batchUpdate POST /v1/{parent=projects/*}/services:batchUpdate
מתבצע עדכון אטומי של הגדרות Service שצוינו.
get GET /v1/{name=projects/*/services/*}
מקבלת את ההגדרות Service עבור שם השירות שצוין.
list GET /v1/{parent=projects/*}/services
בתיבת הדו-שיח הזו מפורטים כל ההגדרות של Service לפרויקט שצוין.
patch PATCH /v1/{service.name=projects/*/services/*}
ההגדרות שצוינו עבור Service יעודכנו.