Yönetici Veritabanı API'sine Giriş

Yönetici SDK'sı ile, tam yönetici ayrıcalıklarıyla veya daha ayrıntılı sınırlı ayrıcalıklarla Gerçek Zamanlı Veritabanı verilerini okuyabilir ve yazabilirsiniz. Bu belgede, Firebase Realtime Database'e erişmek için projenize Firebase Admin SDK'yı eklemeniz konusunda size rehberlik edeceğiz.

Yönetici SDK Kurulumu

Sunucunuzda Firebase Realtime Database'i kullanmaya başlamak için, öncelikle Firebase Admin SDK'yı tercih ettiğiniz dilde kurmanız gerekir.

Yönetici SDK Kimlik Doğrulaması

Firebase Admin SDK'sını kullanan bir sunucudan Firebase Realtime Database'e erişmeden önce, sunucunuzun kimliğini Firebase ile doğrulamanız gerekir. Bir sunucunun kimliğini doğruladığınızda, bir istemci uygulamasında yaptığınız gibi bir kullanıcı hesabının kimlik bilgileriyle oturum açmak yerine, sunucunuzu Firebase'e tanımlayan bir hizmet hesabıyla kimlik doğrulaması yaparsınız.

Firebase Admin SDK'sını kullanarak kimlik doğrulaması yaptığınızda iki farklı erişim düzeyi elde edebilirsiniz:

Firebase Admin SDK Yetkilendirme Erişim Düzeyleri
Yönetici ayrıcalıkları Bir projenin Gerçek Zamanlı Veritabanına tam okuma ve yazma erişimi. Projenizin kaynaklarına sınırsız erişim gerektiren veri taşıma veya yeniden yapılandırma gibi yönetim görevlerini tamamlamak için dikkatli kullanın.
Sınırlı ayrıcalıklar Bir projenin Gerçek Zamanlı Veritabanına erişim, yalnızca sunucunuzun ihtiyaç duyduğu kaynaklarla sınırlıdır. İyi tanımlanmış erişim gereksinimleri olan yönetim görevlerini tamamlamak için bu düzeyi kullanın. Örneğin, tüm veritabanında veri okuyan bir özetleme işi çalıştırırken, salt okunur bir güvenlik kuralı ayarlayarak ve ardından bu kuralla sınırlı ayrıcalıklarla Yönetici SDK'sını başlatarak yanlışlıkla yazma işlemlerine karşı koruma sağlayabilirsiniz.

Yönetici ayrıcalıklarıyla kimlik doğrulaması yapın

Firebase projenizde Düzenleyici rolüne sahip bir hizmet hesabının kimlik bilgileriyle Firebase Admin SDK'sını başlattığınızda, bu örnek projenizin Gerçek Zamanlı Veritabanına tam okuma ve yazma erişimine sahip olur.

Java
// 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());
});
piton
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())
Git
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)

Sınırlı ayrıcalıklarla kimlik doğrulaması yapın

En iyi uygulama olarak, bir hizmetin yalnızca ihtiyaç duyduğu kaynaklara erişimi olmalıdır. Bir Firebase uygulama örneğinin erişebileceği kaynaklar üzerinde daha ayrıntılı kontrol elde etmek için, hizmetinizi temsil eden Güvenlik Kurallarınızda benzersiz bir tanımlayıcı kullanın. Ardından, hizmetinize ihtiyaç duyduğu kaynaklara erişim sağlayan uygun kuralları ayarlayın. Örneğin:

{
  "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'"
    }
  }
}

Ardından, sunucunuzda Firebase uygulamasını başlattığınızda, veritabanı kurallarınız tarafından kullanılan auth nesnesini geçersiz kılmak için databaseAuthVariableOverride seçeneğini kullanın. Bu özel auth nesnesinde, uid alanını, Güvenlik Kurallarınızda hizmetinizi temsil etmek için kullandığınız tanımlayıcıya ayarlayın.

Java
// 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());
});
piton
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())
Git
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)
Bazı durumlarda, kimliği doğrulanmamış bir istemci gibi davranmak için Yönetici SDK'larının kapsamını daraltmak isteyebilirsiniz. Bunu, veritabanı yetkilendirme değişkeni geçersiz kılma için bir null değeri sağlayarak yapabilirsiniz.
Java
// 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());
});
piton
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())
Git
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)

Sonraki adımlar