Uwierzytelnij żądania REST

Pakiety SDK Firebase obsługują całe uwierzytelnianie i komunikację z bazą danych czasu rzeczywistego Firebase w Twoim imieniu. Jeśli jednak znajdujesz się w środowisku, które nie ma pakietu SDK klienta lub chcesz uniknąć obciążenia związanego z trwałym połączeniem z bazą danych, możesz użyć interfejsu API REST bazy danych czasu rzeczywistego do odczytywania i zapisywania danych.

Uwierzytelnij użytkowników jedną z następujących metod:

  1. Tokeny dostępu Google OAuth2 — zazwyczaj możliwość odczytu i zapisu w Bazie danych czasu rzeczywistego podlega regułom bazy danych czasu rzeczywistego . Możesz jednak uzyskać dostęp do swoich danych z serwera i przyznać temu serwerowi pełny dostęp do odczytu i zapisu danych za pomocą tokena dostępu Google OAuth2 wygenerowanego z konta usługi.

  2. Tokeny identyfikatora Firebase — możesz też chcieć wysyłać żądania uwierzytelnione jako pojedynczy użytkownik, na przykład ograniczanie dostępu za pomocą reguł bazy danych czasu rzeczywistego w pakietach SDK klienta. Interfejs API REST akceptuje te same tokeny identyfikatora Firebase, które są używane przez pakiety SDK klienta.

Tokeny dostępu Google OAuth2

Wszelkie dane, które można odczytać lub zapisać publicznie zgodnie z regułami bazy danych czasu rzeczywistego , można również odczytać i zapisać za pośrednictwem interfejsu API REST bez żadnego uwierzytelnienia. Jeśli jednak chcesz, aby serwer omijał reguły bazy danych czasu rzeczywistego, musisz uwierzytelnić żądania odczytu i zapisu. Uwierzytelnianie przez Google OAuth2 wymaga wykonania następujących kroków:

  1. Wygeneruj token dostępu.
  2. Uwierzytelnij się za pomocą tego tokena dostępu.

Wygeneruj token dostępu

Interfejs Realtime Database REST API akceptuje standardowe tokeny dostępu Google OAuth2 . Tokeny dostępu można wygenerować przy użyciu konta usługi z odpowiednimi uprawnieniami do Twojej Bazy Danych Czasu Rzeczywistego. Kliknięcie przycisku Generuj nowy klucz prywatny u dołu sekcji Konta usług w konsoli Firebase umożliwia łatwe wygenerowanie nowego pliku klucza konta usługi, jeśli jeszcze go nie masz.

Po utworzeniu pliku klucza konta usługi możesz użyć jednej z bibliotek klienckich interfejsu API Google, aby wygenerować token dostępu Google OAuth2 o następujących wymaganych zakresach:

  • https://www.googleapis.com/auth/userinfo.email
  • https://www.googleapis.com/auth/firebase.database

Oto kilka przykładowych implementacji, które pokazują, jak tworzyć tokeny dostępu Google OAuth2 do uwierzytelniania w interfejsie Realtime Database REST API w różnych językach:

Node.js

Korzystanie z biblioteki klienta interfejsu API Google dla Node.js :

var {google} = require("googleapis");

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

// Define the required scopes.
var scopes = [
  "https://www.googleapis.com/auth/userinfo.email",
  "https://www.googleapis.com/auth/firebase.database"
];

// Authenticate a JWT client with the service account.
var jwtClient = new google.auth.JWT(
  serviceAccount.client_email,
  null,
  serviceAccount.private_key,
  scopes
);

// Use the JWT client to generate an access token.
jwtClient.authorize(function(error, tokens) {
  if (error) {
    console.log("Error making request to generate access token:", error);
  } else if (tokens.access_token === null) {
    console.log("Provided service account does not have permission to generate access tokens");
  } else {
    var accessToken = tokens.access_token;

    // See the "Using the access token" section below for information
    // on how to use the access token to send authenticated requests to
    // the Realtime Database REST API.
  }
});

Jawa

Korzystanie z biblioteki klienta interfejsu API Google dla języka Java :

// Load the service account key JSON file
FileInputStream serviceAccount = new FileInputStream("path/to/serviceAccountKey.json");

// Authenticate a Google credential with the service account
GoogleCredential googleCred = GoogleCredential.fromStream(serviceAccount);

// Add the required scopes to the Google credential
GoogleCredential scoped = googleCred.createScoped(
    Arrays.asList(
      "https://www.googleapis.com/auth/firebase.database",
      "https://www.googleapis.com/auth/userinfo.email"
    )
);

// Use the Google credential to generate an access token
scoped.refreshToken();
String token = scoped.getAccessToken();

// See the "Using the access token" section below for information
// on how to use the access token to send authenticated requests to the
// Realtime Database REST API.

Pyton

Korzystanie z biblioteki google-auth :

from google.oauth2 import service_account
from google.auth.transport.requests import AuthorizedSession

# Define the required scopes
scopes = [
  "https://www.googleapis.com/auth/userinfo.email",
  "https://www.googleapis.com/auth/firebase.database"
]

# Authenticate a credential with the service account
credentials = service_account.Credentials.from_service_account_file(
    "path/to/serviceAccountKey.json", scopes=scopes)

# Use the credentials object to authenticate a Requests session.
authed_session = AuthorizedSession(credentials)
response = authed_session.get(
    "https://<DATABASE_NAME>.firebaseio.com/users/ada/name.json")

# Or, use the token directly, as described in the "Authenticate with an
# access token" section below. (not recommended)
request = google.auth.transport.requests.Request()
credentials.refresh(request)
access_token = credentials.token

Uwierzytelnij się za pomocą tokena dostępu

Aby wysyłać uwierzytelnione żądania do interfejsu Realtime Database REST API, przekaż wygenerowany powyżej token dostępu Google OAuth2 jako nagłówek Authorization: Bearer <ACCESS_TOKEN> lub parametr ciągu zapytania access_token=<ACCESS_TOKEN> . Oto przykładowe żądanie curl , aby odczytać imię Ady:

curl "https://<DATABASE_NAME>.firebaseio.com/users/ada/name.json?access_token=<ACCESS_TOKEN>"

Pamiętaj, aby zastąpić <DATABASE_NAME> nazwą swojej Bazy danych czasu rzeczywistego, a <ACCESS_TOKEN> tokenem dostępu Google OAuth2.

Pomyślne żądanie zostanie wskazane przez kod stanu HTTP 200 OK . Odpowiedź zawiera pobierane dane:

{"first":"Ada","last":"Lovelace"}

Tokeny Firebase ID

Gdy użytkownik lub urządzenie loguje się przy użyciu uwierzytelniania Firebase, Firebase tworzy odpowiedni token identyfikacyjny, który jednoznacznie identyfikuje go i zapewnia dostęp do kilku zasobów, takich jak Baza danych czasu rzeczywistego i Cloud Storage. Możesz ponownie użyć tego tokena identyfikatora do uwierzytelniania interfejsu API REST bazy danych czasu rzeczywistego i wysyłania żądań w imieniu tego użytkownika.

Wygeneruj token identyfikacyjny

Aby pobrać token ID Firebase z klienta, wykonaj czynności opisane w sekcji Pobieranie tokenów ID na klientach .

Pamiętaj, że tokeny ID wygasają po krótkim czasie i powinny być używane tak szybko, jak to możliwe po ich odzyskaniu.

Uwierzytelnij się za pomocą tokena ID

Aby wysyłać uwierzytelnione żądania do interfejsu API REST Realtime Database, przekaż wygenerowany powyżej token identyfikatora jako parametr ciągu zapytania auth=<ID_TOKEN> . Oto przykładowe żądanie curl , aby odczytać imię Ady:

curl "https://<DATABASE_NAME>.firebaseio.com/users/ada/name.json?auth=<ID_TOKEN>"

Pamiętaj, aby zastąpić <DATABASE_NAME> nazwą swojej Bazy danych czasu rzeczywistego, a <ID_TOKEN> ID.

Pomyślne żądanie zostanie wskazane przez kod stanu HTTP 200 OK . Odpowiedź zawiera pobierane dane:

{"first":"Ada","last":"Lovelace"}

Tokeny starszego typu

Jeśli nadal używasz starszych tokenów uwierzytelniania Firebase, zalecamy zaktualizowanie uwierzytelniania REST do jednej z metod uwierzytelniania opisanych powyżej.

Interfejs API REST bazy danych czasu rzeczywistego nadal obsługuje uwierzytelnianie za pomocą starszych tokenów uwierzytelniania, w tym kluczy tajnych . Sekrety tajne Bazy danych czasu rzeczywistego można znaleźć w sekcji Konta usług w konsoli Firebase.