Catch up on everything announced at Firebase Summit, and learn how Firebase can help you accelerate app development and run your app with confidence. Learn More

Adicione o SDK Admin do Firebase ao seu servidor

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

O Admin SDK é um conjunto de bibliotecas de servidor que permite interagir com o Firebase a partir de ambientes privilegiados para realizar ações como:

  • Leia e grave dados do Realtime Database com privilégios totais de administrador.
  • Envie mensagens do Firebase Cloud Messaging programaticamente usando uma abordagem simples e alternativa aos protocolos do servidor do Firebase Cloud Messaging.
  • Gere e verifique os tokens de autenticação do Firebase.
  • Acesse recursos do Google Cloud, como buckets do Cloud Storage e bancos de dados do Cloud Firestore associados aos seus projetos do Firebase.
  • Crie seu próprio console de administração simplificado para fazer coisas como procurar dados do usuário ou alterar o endereço de e-mail de um usuário para autenticação.

Se você estiver interessado em usar o Node.js SDK como um cliente para acesso do usuário final (por exemplo, em um desktop Node.js ou aplicativo IoT), em oposição ao acesso administrativo de um ambiente privilegiado (como um servidor), você em vez disso, deve seguir as instruções para configurar o cliente JavaScript SDK .

Aqui está uma matriz de recursos mostrando quais recursos do Firebase são suportados em cada idioma:

Característica Node.js Java Pitão Vai C #
Cunhagem de Token Personalizado
Verificação de token de ID
Gerenciamento de usuários
Controle o acesso com declarações personalizadas
Atualizar revogação de token
Importar usuários
Gerenciamento de cookies de sessão
Gerando links de ação de e-mail
Gerenciando as configurações do provedor SAML/OIDC
Suporte multilocação
banco de dados em tempo real *
Firebase Cloud Messaging
Multitransmissão FCM
Gerenciar assinaturas de tópicos do FCM
Armazenamento na núvem
Cloud Firestore
Gerenciamento de projetos
Regras de segurança
Gerenciamento de modelos de ML
Configuração remota do Firebase
Verificação do aplicativo Firebase
Extensões do Firebase

Para saber mais sobre a integração do Admin SDK para esses usos, consulte a documentação correspondente do Realtime Database , FCM , Authentication , Remote Config e Cloud Storage . O restante desta página se concentra na configuração básica do Admin SDK.

Pré-requisitos

  • Certifique-se de ter um aplicativo de servidor.

  • Certifique-se de que seu servidor execute o seguinte, dependendo de qual Admin SDK você usa:

    • SDK Admin Node.js — Node.js 14+
    • SDK Admin Java — Java 8+
    • Admin Python SDK — Python 3.6+ (recomendo Python 3.7+)
    • SDK Admin Go — Go 1.15+
    • Admin .NET SDK — .NET Framework 4.6.1+ ou .NET Standard 2.0 para .Net Core 2.0+

Configurar um projeto Firebase e uma conta de serviço

Para usar o Firebase Admin SDK, você precisará do seguinte:

  • Um projeto do Firebase.
  • Uma conta de serviço do Firebase Admin SDK para se comunicar com o Firebase. Essa conta de serviço é criada automaticamente quando você cria um projeto do Firebase ou adiciona o Firebase a um projeto do Google Cloud.
  • Um arquivo de configuração com as credenciais da sua conta de serviço.

Se você ainda não tem um projeto do Firebase, precisa criar um no console do Firebase . Acesse Entenda os projetos do Firebase para saber mais sobre os projetos do Firebase.

Adicionar o SDK

Se você estiver configurando um novo projeto, precisará instalar o SDK para o idioma de sua escolha.

Node.js

O Firebase Admin Node.js SDK está disponível no npm. Se você ainda não tiver um arquivo package.json , crie um via npm init . Em seguida, instale o pacote firebase firebase-admin npm e salve-o em seu package.json :

npm install firebase-admin --save

Para usar o módulo em seu aplicativo, require -o de qualquer arquivo JavaScript:

const { initializeApp } = require('firebase-admin/app');

Se você estiver usando o ES2015, poderá import o módulo:

import { initializeApp } from 'firebase-admin/app';

Java

O Firebase Admin Java SDK é publicado no repositório central do Maven. Para instalar a biblioteca, declare-a como uma dependência em seu arquivo build.gradle :

dependencies {
  implementation 'com.google.firebase:firebase-admin:9.1.1'
}

Se você usar o Maven para criar seu aplicativo, poderá adicionar a seguinte dependência ao seu pom.xml :

<dependency>
  <groupId>com.google.firebase</groupId>
  <artifactId>firebase-admin</artifactId>
  <version>9.1.1</version>
</dependency>

Pitão

O Firebase Admin Python SDK está disponível via pip . Você pode instalar a biblioteca para todos os usuários via sudo :

sudo pip install firebase-admin

Ou você pode instalar a biblioteca apenas para o usuário atual passando o sinalizador --user :

pip install --user firebase-admin

Vai

O Go Admin SDK pode ser instalado usando o utilitário go get :

# Install as a module dependency
go get firebase.google.com/go/v4

# Install to $GOPATH
go get firebase.google.com/go

C #

O .NET Admin SDK pode ser instalado usando o gerenciador de pacotes .NET:

Install-Package FirebaseAdmin -Version 2.3.0

Como alternativa, instale-o usando o utilitário de linha de comando dotnet :

dotnet add package FirebaseAdmin --version 2.3.0

Ou você pode instalá-lo adicionando a seguinte entrada de referência de pacote ao seu arquivo .csproj :

<ItemGroup>
  <PackageReference Include="FirebaseAdmin" Version="2.3.0" />
</ItemGroup>

Inicializar o SDK

Depois de criar um projeto do Firebase, você pode inicializar o SDK com uma estratégia de autorização que combina seu arquivo de conta de serviço com o Google Application Default Credentials .

Os projetos do Firebase oferecem suporte a contas de serviço do Google , que você pode usar para chamar APIs do servidor Firebase de seu servidor de aplicativos ou ambiente confiável. Se você estiver desenvolvendo código localmente ou implantando seu aplicativo no local, poderá usar as credenciais obtidas por meio dessa conta de serviço para autorizar solicitações de servidor.

Para autenticar uma conta de serviço e autorizá-la a acessar os serviços do Firebase, você deve gerar um arquivo de chave privada no formato JSON.

Para gerar um arquivo de chave privada para sua conta de serviço:

  1. No console do Firebase, abra Configurações > Contas de serviço .

  2. Clique em Gerar nova chave privada e confirme clicando em Gerar chave .

  3. Armazene com segurança o arquivo JSON que contém a chave.

Ao autorizar por meio de uma conta de serviço, você tem duas opções para fornecer as credenciais ao seu aplicativo. Você pode definir a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS ou passar explicitamente o caminho para a chave da conta de serviço no código. A primeira opção é mais segura e é fortemente recomendada.

Para definir a variável de ambiente:

Defina a variável de ambiente GOOGLE_APPLICATION_CREDENTIALS como o caminho do arquivo JSON que contém a chave da conta de serviço. Esta variável aplica-se apenas à sua sessão de shell atual, portanto, se você abrir uma nova sessão, defina a variável novamente.

Linux ou macOS

export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"

janelas

Com PowerShell:

$env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"

Depois de concluir as etapas acima, o Application Default Credentials (ADC) pode determinar implicitamente suas credenciais, permitindo que você use as credenciais da conta de serviço ao testar ou executar em ambientes que não sejam do Google.

Inicialize o SDK como mostrado:

Node.js

initializeApp({
    credential: applicationDefault(),
    databaseURL: 'https://<DATABASE_NAME>.firebaseio.com'
});

Java

FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.getApplicationDefault())
    .setDatabaseUrl("https://<DATABASE_NAME>.firebaseio.com/")
    .build();

FirebaseApp.initializeApp(options);

Pitão

default_app = firebase_admin.initialize_app()

Vai

app, err := firebase.NewApp(context.Background(), nil)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

C #

FirebaseApp.Create(new AppOptions()
{
    Credential = GoogleCredential.GetApplicationDefault(),
});

Usando um token de atualização OAuth 2.0

O Admin SDK também fornece uma credencial que permite a autenticação com um token de atualização do Google OAuth2 :

Node.js

const myRefreshToken = '...'; // Get refresh token from OAuth2 flow

initializeApp({
  credential: refreshToken(myRefreshToken),
  databaseURL: 'https://<DATABASE_NAME>.firebaseio.com'
});

Java

FileInputStream refreshToken = new FileInputStream("path/to/refreshToken.json");

FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.fromStream(refreshToken))
    .setDatabaseUrl("https://<DATABASE_NAME>.firebaseio.com/")
    .build();

FirebaseApp.initializeApp(options);

Pitão

cred = credentials.RefreshToken('path/to/refreshToken.json')
default_app = firebase_admin.initialize_app(cred)

Vai

opt := option.WithCredentialsFile("path/to/refreshToken.json")
config := &firebase.Config{ProjectID: "my-project-id"}
app, err := firebase.NewApp(context.Background(), config, opt)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

C #

FirebaseApp.Create(new AppOptions()
{
    Credential = GoogleCredential.FromFile("path/to/refreshToken.json"),
});

Inicializar sem parâmetros

O SDK também pode ser inicializado sem parâmetros. Nesse caso, o SDK usa o Google Application Default Credentials . Como a pesquisa de credenciais padrão é totalmente automatizada nos ambientes do Google, sem a necessidade de fornecer variáveis ​​de ambiente ou outra configuração, essa forma de inicializar o SDK é altamente recomendada para aplicativos em execução no Compute Engine, Kubernetes Engine, App Engine e Cloud Functions.

Para especificar opcionalmente opções de inicialização para serviços como Realtime Database, Cloud Storage ou Cloud Functions, use a variável de ambiente FIREBASE_CONFIG . Se o conteúdo da variável FIREBASE_CONFIG começar com um { , ele será analisado como um objeto JSON. Caso contrário, o SDK assume que a string é o caminho de um arquivo JSON contendo as opções.

Node.js

const app = initializeApp();

Java

FirebaseApp.initializeApp();

Pitão

default_app = firebase_admin.initialize_app()

Vai

app, err := firebase.NewApp(context.Background(), nil)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

C #

FirebaseApp.Create();

Depois de inicializado, você pode usar o Admin SDK para realizar os seguintes tipos de tarefas:

Inicializar vários aplicativos

Na maioria dos casos, você só precisa inicializar um único aplicativo padrão. Você pode acessar serviços desse aplicativo de duas maneiras equivalentes:

Node.js

// Initialize the default app
const defaultApp = initializeApp(defaultAppConfig);

console.log(defaultApp.name);  // '[DEFAULT]'

// Retrieve services via the defaultApp variable...
let defaultAuth = getAuth(defaultApp);
let defaultDatabase = getDatabase(defaultApp);

// ... or use the equivalent shorthand notation
defaultAuth = getAuth();
defaultDatabase = getDatabase();

Java

// Initialize the default app
FirebaseApp defaultApp = FirebaseApp.initializeApp(defaultOptions);

System.out.println(defaultApp.getName());  // "[DEFAULT]"

// Retrieve services by passing the defaultApp variable...
FirebaseAuth defaultAuth = FirebaseAuth.getInstance(defaultApp);
FirebaseDatabase defaultDatabase = FirebaseDatabase.getInstance(defaultApp);

// ... or use the equivalent shorthand notation
defaultAuth = FirebaseAuth.getInstance();
defaultDatabase = FirebaseDatabase.getInstance();

Pitão

# Import the Firebase service
from firebase_admin import auth

# Initialize the default app
default_app = firebase_admin.initialize_app(cred)
print(default_app.name)  # "[DEFAULT]"

# Retrieve services via the auth package...
# auth.create_custom_token(...)

Vai

// Initialize default app
app, err := firebase.NewApp(context.Background(), nil)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

// Access auth service from the default app
client, err := app.Auth(context.Background())
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

C #

// Initialize the default app
var defaultApp = FirebaseApp.Create(new AppOptions()
{
    Credential = GoogleCredential.GetApplicationDefault(),
});
Console.WriteLine(defaultApp.Name); // "[DEFAULT]"

// Retrieve services by passing the defaultApp variable...
var defaultAuth = FirebaseAuth.GetAuth(defaultApp);

// ... or use the equivalent shorthand notation
defaultAuth = FirebaseAuth.DefaultInstance;

Alguns casos de uso exigem que você crie vários aplicativos ao mesmo tempo. Por exemplo, talvez você queira ler dados do Realtime Database de um projeto do Firebase e criar tokens personalizados para outro projeto. Ou você pode querer autenticar dois aplicativos com credenciais separadas. O Firebase SDK permite criar vários aplicativos ao mesmo tempo, cada um com suas próprias informações de configuração.

Node.js

// Initialize the default app
initializeApp(defaultAppConfig);

// Initialize another app with a different config
var otherApp = initializeApp(otherAppConfig, 'other');

console.log(getApp().name);  // '[DEFAULT]'
console.log(otherApp.name);     // 'other'

// Use the shorthand notation to retrieve the default app's services
const defaultAuth = getAuth();
const defaultDatabase = getDatabase();

// Use the otherApp variable to retrieve the other app's services
const otherAuth = getAuth(otherApp);
const otherDatabase = getDatabase(otherApp);

Java

// Initialize the default app
FirebaseApp defaultApp = FirebaseApp.initializeApp(defaultOptions);

// Initialize another app with a different config
FirebaseApp otherApp = FirebaseApp.initializeApp(otherAppConfig, "other");

System.out.println(defaultApp.getName());  // "[DEFAULT]"
System.out.println(otherApp.getName());    // "other"

// Use the shorthand notation to retrieve the default app's services
FirebaseAuth defaultAuth = FirebaseAuth.getInstance();
FirebaseDatabase defaultDatabase = FirebaseDatabase.getInstance();

// Use the otherApp variable to retrieve the other app's services
FirebaseAuth otherAuth = FirebaseAuth.getInstance(otherApp);
FirebaseDatabase otherDatabase = FirebaseDatabase.getInstance(otherApp);

Pitão

# Initialize the default app
default_app = firebase_admin.initialize_app(cred)

#  Initialize another app with a different config
other_app = firebase_admin.initialize_app(cred, name='other')

print(default_app.name)    # "[DEFAULT]"
print(other_app.name)      # "other"

# Retrieve default services via the auth package...
# auth.create_custom_token(...)

# Use the `app` argument to retrieve the other app's services
# auth.create_custom_token(..., app=other_app)

Vai

// Initialize the default app
defaultApp, err := firebase.NewApp(context.Background(), nil)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

// Initialize another app with a different config
opt := option.WithCredentialsFile("service-account-other.json")
otherApp, err := firebase.NewApp(context.Background(), nil, opt)
if err != nil {
	log.Fatalf("error initializing app: %v\n", err)
}

// Access Auth service from default app
defaultClient, err := defaultApp.Auth(context.Background())
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

// Access auth service from other app
otherClient, err := otherApp.Auth(context.Background())
if err != nil {
	log.Fatalf("error getting Auth client: %v\n", err)
}

C #

// Initialize the default app
var defaultApp = FirebaseApp.Create(defaultOptions);

// Initialize another app with a different config
var otherApp = FirebaseApp.Create(otherAppConfig, "other");

Console.WriteLine(defaultApp.Name); // "[DEFAULT]"
Console.WriteLine(otherApp.Name); // "other"

// Use the shorthand notation to retrieve the default app's services
var defaultAuth = FirebaseAuth.DefaultInstance;

// Use the otherApp variable to retrieve the other app's services
var otherAuth = FirebaseAuth.GetAuth(otherApp);

Definir escopos para banco de dados e autenticação em tempo real

Se você estiver usando uma VM do Google Compute Engine com o Google Application Default Credentials para Realtime Database ou Authentication, certifique-se de definir também os escopos de acesso corretos . Para banco de dados e autenticação em tempo real, você precisa de escopos que terminem em userinfo.email e cloud-platform ou firebase.database . Para verificar os escopos de acesso existentes e alterá-los, execute os seguintes comandos usando gcloud .

gcloud

# Check the existing access scopes
gcloud compute instances describe [INSTANCE_NAME] --format json

# The above command returns the service account information. For example:
  "serviceAccounts": [
   {
    "email": "your.gserviceaccount.com",
    "scopes": [
     "https://www.googleapis.com/auth/cloud-platform",
     "https://www.googleapis.com/auth/userinfo.email"
     ]
    }
  ],

# Stop the VM, then run the following command, using the service account
# that gcloud returned when you checked the scopes.

gcloud compute instances set-service-account [INSTANCE_NAME] --service-account "your.gserviceaccount.com" --scopes "https://www.googleapis.com/auth/firebase.database,https://www.googleapis.com/auth/userinfo.email"

Teste com credenciais de usuário final gcloud

Ao testar o Admin SDK localmente com o Google Application Default Credentials obtido executando gcloud auth application-default login , são necessárias alterações adicionais para usar o Firebase Authentication devido ao seguinte:

  • O Firebase Authentication não aceita credenciais de usuário final gcloud geradas usando o ID do cliente gcloud OAuth.
  • O Firebase Authentication exige que o ID do projeto seja fornecido na inicialização para esse tipo de credencial de usuário final.

Como solução alternativa, você pode gerar Google Application Default Credentials em gcloud usando seu próprio ID de cliente OAuth 2.0 . O ID do cliente OAuth deve ser um tipo de aplicativo de aplicativo de área de trabalho.

gcloud

gcloud auth application-default login --client-id-file=[/path/to/client/id/file]

Você pode especificar o ID do projeto explicitamente na inicialização do aplicativo ou apenas usar a variável de ambiente GOOGLE_CLOUD_PROJECT . O último evita a necessidade de fazer alterações adicionais para testar seu código.

Para especificar explicitamente o ID do projeto:

Node.js

import { initializeApp, applicationDefault } from 'firebase-admin/app';

initializeApp({
  credential: applicationDefault(),
  projectId: '<FIREBASE_PROJECT_ID>',
});

Java

FirebaseOptions options = FirebaseOptions.builder()
    .setCredentials(GoogleCredentials.getApplicationDefault())
    .setProjectId("<FIREBASE_PROJECT_ID>")
    .build();

FirebaseApp.initializeApp(options);

Pitão

app_options = {'projectId': '<FIREBASE_PROJECT_ID>'}
default_app = firebase_admin.initialize_app(options=app_options)

Vai

config := &firebase.Config{ProjectID: "<FIREBASE_PROJECT_ID>"}
app, err := firebase.NewApp(context.Background(), config)
if err != nil {
        log.Fatalf("error initializing app: %v\n", err)
}

C #

FirebaseApp.Create(new AppOptions()
{
    Credential = GoogleCredential.GetApplicationDefault(),
    ProjectId = "<FIREBASE_PROJECT_ID>",
});

Próximos passos

Conheça o Firebase:

Adicione recursos do Firebase ao seu aplicativo: