מבוא לממשק ה- API של מנהל המערכת

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

הגדרת SDK מנהל מערכת

כדי להתחיל עם מסד הנתונים האמיתי של Firebase בשרת שלך, תחילה תצטרך להגדיר את ה- SDK של מנהל המערכת של Firebase בשפת בחירתך.

אימות SDK מנהל מערכת

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

אתה יכול לקבל שתי רמות גישה שונות כאשר אתה מאמת באמצעות SDK של מנהל המערכת של Firebase:

Firebase Admin SDK Auths Levels Levels
הרשאות מנהליות השלם גישה לקריאה וכתיבה למאגר בזמן אמת של הפרויקט. השתמש בזהירות כדי להשלים משימות ניהוליות כגון העברת נתונים או ארגון מחדש המחייב גישה בלתי מוגבלת למשאבי הפרויקט שלך.
הרשאות מוגבלות גישה למסד הנתונים בזמן אמת של פרויקט, מוגבלת רק למשאבים שהשרת שלך זקוק להם. השתמש ברמה זו כדי להשלים משימות ניהוליות שיש בהן דרישות גישה מוגדרות היטב. לדוגמה, כאשר אתה מריץ עבודת סיכום שקוראת נתונים על פני כל מסד הנתונים, אתה יכול להגן מפני כתיבה בשוגג על ידי הגדרת כלל אבטחה לקריאה בלבד ואז אתחול ה- SDK למנהלי מערכת עם הרשאות המוגבלות על ידי כלל זה.

אמת עם הרשאות מנהל

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

ג'אווה
// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccount.json");

// Initialize the app with a service account, granting admin privileges
FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.fromStream(serviceAccount))
    .setDatabaseUrl("https://databaseName.firebaseio.com")
    // Or other region, e.g. <databaseName>.europe-west1.firebasedatabase.app
    .build();
FirebaseApp.initializeApp(options);

// As an admin, the app has access to read and write all data, regardless of Security Rules
DatabaseReference ref = FirebaseDatabase.getInstance()
    .getReference("restricted_access/secret_document");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
  @Override
  public void onDataChange(DataSnapshot dataSnapshot) {
    Object document = dataSnapshot.getValue();
    System.out.println(document);
  }

  @Override
  public void onCancelled(DatabaseError error) {
  }
});
Node.js
var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a service account, granting admin privileges
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  databaseURL: "https://databaseName.firebaseio.com"
});

// As an admin, the app has access to read and write all data, regardless of Security Rules
var db = admin.database();
var ref = db.ref("restricted_access/secret_document");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});
פִּיתוֹן
import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a service account, granting admin privileges
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com'
})

# As an admin, the app has access to read and write all data, regradless of Security Rules
ref = db.reference('restricted_access/secret_document')
print(ref.get())
ללכת
ctx := context.Background()
conf := &firebase.Config{
	DatabaseURL: "https://databaseName.firebaseio.com",
}
// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

// Initialize the app with a service account, granting admin privileges
app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// As an admin, the app has access to read and write all data, regradless of Security Rules
ref := client.NewRef("restricted_access/secret_document")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)

אמת עם הרשאות מוגבלות

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

{
  "rules": {
    "public_resource": {
      ".read": true,
      ".write": true
    },
    "some_resource": {
      ".read": "auth.uid === 'my-service-worker'",
      ".write": false
    },
    "another_resource": {
      ".read": "auth.uid === 'my-service-worker'",
      ".write": "auth.uid === 'my-service-worker'"
    }
  }
}

לאחר מכן, בשרת שלך, בעת אתחול היישום של Firebase, השתמש באפשרות databaseAuthVariableOverride כדי לעקוף את אובייקט ה- auth המשמש את כללי מסד הנתונים שלך. באובייקט auth מותאם אישית זה, הגדר את שדה uid למזהה בו השתמשת לייצוג השירות שלך בכללי האבטחה שלך.

ג'אווה
// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountCredentials.json");

// Initialize the app with a custom auth variable, limiting the server's access
Map<String, Object> auth = new HashMap<String, Object>();
auth.put("uid", "my-service-worker");

FirebaseOptions options = new FirebaseOptions.Builder()
    .setCredential(FirebaseCredentials.fromCertificate(serviceAccount))
    .setDatabaseUrl("https://databaseName.firebaseio.com")
    .setDatabaseAuthVariableOverride(auth)
    .build();
FirebaseApp.initializeApp(options);

// The app only has access as defined in the Security Rules
DatabaseReference ref = FirebaseDatabase
    .getInstance()
    .getReference("/some_resource");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        String res = dataSnapshot.getValue();
        System.out.println(res);
    }
});
Node.js
var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a custom auth variable, limiting the server's access
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  databaseURL: "https://databaseName.firebaseio.com",
  databaseAuthVariableOverride: {
    uid: "my-service-worker"
  }
});

// The app only has access as defined in the Security Rules
var db = admin.database();
var ref = db.ref("/some_resource");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});
פִּיתוֹן
import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a custom auth variable, limiting the server's access
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com',
    'databaseAuthVariableOverride': {
        'uid': 'my-service-worker'
    }
})

# The app only has access as defined in the Security Rules
ref = db.reference('/some_resource')
print(ref.get())
ללכת
ctx := context.Background()
// Initialize the app with a custom auth variable, limiting the server's access
ao := map[string]interface{}{"uid": "my-service-worker"}
conf := &firebase.Config{
	DatabaseURL:  "https://databaseName.firebaseio.com",
	AuthOverride: &ao,
}

// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// The app only has access as defined in the Security Rules
ref := client.NewRef("/some_resource")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)
במקרים מסוימים, ייתכן שתרצה להקטין את ערכות ה- SDK של מנהל המערכת כדי לשמש כלקוח לא מאומת. באפשרותך לעשות זאת על ידי מתן ערך null עבור עקיפת משתנה אימות מסד הנתונים.
ג'אווה
// Fetch the service account key JSON file contents
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountCredentials.json");

FirebaseOptions options = new FirebaseOptions.Builder()
    .setCredential(FirebaseCredentials.fromCertificate(serviceAccount))
    .setDatabaseUrl("https://databaseName.firebaseio.com")
    .setDatabaseAuthVariableOverride(null)
    .build();
FirebaseApp.initializeApp(options);

// The app only has access to public data as defined in the Security Rules
DatabaseReference ref = FirebaseDatabase
    .getInstance()
    .getReference("/public_resource");
ref.addListenerForSingleValueEvent(new ValueEventListener() {
    @Override
    public void onDataChange(DataSnapshot dataSnapshot) {
        String res = dataSnapshot.getValue();
        System.out.println(res);
    }
});
Node.js
var admin = require("firebase-admin");

// Fetch the service account key JSON file contents
var serviceAccount = require("path/to/serviceAccountKey.json");

// Initialize the app with a null auth variable, limiting the server's access
admin.initializeApp({
  credential: admin.credential.cert(serviceAccount),
  databaseURL: "https://databaseName.firebaseio.com",
  databaseAuthVariableOverride: null
});

// The app only has access to public data as defined in the Security Rules
var db = admin.database();
var ref = db.ref("/public_resource");
ref.once("value", function(snapshot) {
  console.log(snapshot.val());
});
פִּיתוֹן
import firebase_admin
from firebase_admin import credentials
from firebase_admin import db

# Fetch the service account key JSON file contents
cred = credentials.Certificate('path/to/serviceAccountKey.json')

# Initialize the app with a None auth variable, limiting the server's access
firebase_admin.initialize_app(cred, {
    'databaseURL': 'https://databaseName.firebaseio.com',
    'databaseAuthVariableOverride': None
})

# The app only has access to public data as defined in the Security Rules
ref = db.reference('/public_resource')
print(ref.get())
ללכת
ctx := context.Background()
// Initialize the app with a nil auth variable, limiting the server's access
var nilMap map[string]interface{}
conf := &firebase.Config{
	DatabaseURL:  "https://databaseName.firebaseio.com",
	AuthOverride: &nilMap,
}

// Fetch the service account key JSON file contents
opt := option.WithCredentialsFile("path/to/serviceAccountKey.json")

app, err := firebase.NewApp(ctx, conf, opt)
if err != nil {
	log.Fatalln("Error initializing app:", err)
}

client, err := app.Database(ctx)
if err != nil {
	log.Fatalln("Error initializing database client:", err)
}

// The app only has access to public data as defined in the Security Rules
ref := client.NewRef("/some_resource")
var data map[string]interface{}
if err := ref.Get(ctx, &data); err != nil {
	log.Fatalln("Error reading from database:", err)
}
fmt.Println(data)

הצעדים הבאים