Google is committed to advancing racial equity for Black communities. See how.
Trang này được dịch bởi Cloud Translation API.
Switch to English

Di chuyển từ HTTP cũ sang HTTP v1

Các ứng dụng sử dụng API HTTP cũ của FCM nên cân nhắc chuyển sang API HTTP v1 bằng cách sử dụng các hướng dẫn trong hướng dẫn này. API HTTP v1 có những ưu điểm này so với API kế thừa:

  • Bảo mật tốt hơn thông qua mã thông báo truy cập API HTTP v1 sử dụng mã thông báo truy cập tồn tại trong thời gian ngắn theo mô hình bảo mật OAuth2. Trong trường hợp mã thông báo truy cập được công khai, nó chỉ có thể bị sử dụng với mục đích xấu trong một giờ hoặc lâu hơn trước khi hết hạn. Các mã làm mới không được truyền thường xuyên như các khóa bảo mật được sử dụng trong API kế thừa, vì vậy chúng ít có khả năng bị bắt hơn nhiều.

  • Tùy chỉnh thông báo hiệu quả hơn trên các nền tảng Đối với nội dung thông báo, API HTTP v1 có các khóa chung dùng cho tất cả các phiên bản được nhắm mục tiêu, cùng với các khóa dành riêng cho nền tảng cho phép bạn tùy chỉnh thông báo trên các nền tảng. Điều này cho phép bạn tạo "ghi đè" gửi các tải trọng hơi khác nhau đến các nền tảng khách hàng khác nhau trong một tin nhắn.

  • Có thể mở rộng hơn và chống lại tương lai cho các phiên bản nền tảng khách hàng mới API HTTP v1 hỗ trợ đầy đủ các tùy chọn nhắn tin có sẵn trên iOS, Android và Web. Vì mỗi nền tảng có khối xác định riêng trong tải trọng JSON, FCM có thể mở rộng API sang các phiên bản mới và nền tảng mới nếu cần.

Cập nhật điểm cuối máy chủ

URL điểm cuối cho API HTTP v1 khác với điểm cuối kế thừa theo những cách sau:

  • Nó được tạo phiên bản, với /v1 trong đường dẫn.
  • Đường dẫn chứa ID dự án của dự án Firebase cho ứng dụng của bạn, ở định dạng /projects/myproject-ID/ . ID này có sẵn trong tab Cài đặt dự án chung của bảng điều khiển Firebase.
  • Nó chỉ định rõ ràng chỉ định phương thức send:send .

Để cập nhật điểm cuối máy chủ cho HTTP v1, hãy thêm các phần tử này vào điểm cuối trong tiêu đề yêu cầu gửi của bạn.

Trước

POST https://fcm.googleapis.com/fcm/send

Sau

POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send

Cập nhật ủy quyền gửi yêu cầu

Thay cho chuỗi khóa máy chủ được sử dụng trong các yêu cầu kế thừa, yêu cầu gửi HTTP v1 yêu cầu mã thông báo truy cập OAuth 2.0. Nếu bạn đang sử dụng SDK quản trị để gửi tin nhắn, thư viện sẽ xử lý mã thông báo cho bạn. Nếu bạn đang sử dụng giao thức thô, hãy lấy mã thông báo như được mô tả trong phần này và thêm nó vào tiêu đề dưới dạng Authorization: Bearer <valid Oauth 2.0 token> .

Trước

Authorization: key=AIzaSyZ-1u...0GBYzPu7Udno5aA

Sau

Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA

Tùy thuộc vào thông tin chi tiết về môi trường máy chủ của bạn, hãy sử dụng kết hợp các chiến lược sau để cho phép các yêu cầu máy chủ tới các dịch vụ Firebase:

  • Thông tin đăng nhập mặc định của ứng dụng Google (ADC)
  • Tệp JSON tài khoản dịch vụ
  • Mã thông báo truy cập OAuth 2.0 tồn tại trong thời gian ngắn có nguồn gốc từ tài khoản dịch vụ

Nếu ứng dụng của bạn đang chạy trên Compute Engine, Kubernetes Engine, App Engine hoặc Cloud Functions (bao gồm cả Cloud Functions cho Firebase), hãy sử dụng Application Default Credentials (ADC). ADC sử dụng tài khoản dịch vụ mặc định hiện có của bạn để lấy thông tin xác thực để cho phép yêu cầu và ADC cho phép kiểm tra cục bộ linh hoạt thông qua biến môi trường GOOGLE_APPLICATION_CREDENTIALS . Để quy trình ủy quyền được tự động hóa hoàn toàn, hãy sử dụng ADC cùng với thư viện máy chủ SDK quản trị viên.

Nếu ứng dụng của bạn đang chạy trên môi trường máy chủ không phải của Google , bạn sẽ cần tải xuống tệp JSON tài khoản dịch vụ từ dự án Firebase của mình. Miễn là bạn có quyền truy cập vào hệ thống tệp có chứa tệp khóa cá nhân, bạn có thể sử dụng biến môi trường GOOGLE_APPLICATION_CREDENTIALS để cho phép các yêu cầu bằng các thông tin xác thực được lấy theo cách thủ công này. Nếu bạn thiếu quyền truy cập tệp như vậy, bạn phải tham chiếu tệp tài khoản dịch vụ trong mã của mình— việc này cần được thực hiện hết sức cẩn thận do nguy cơ lộ thông tin đăng nhập của bạn.

Cung cấp thông tin đăng nhập bằng ADC

Thông tin đăng nhập mặc định của ứng dụng Google (ADC) kiểm tra thông tin đăng nhập của bạn theo thứ tự sau:

  1. ADC kiểm tra xem biến môi trường GOOGLE_APPLICATION_CREDENTIALS được đặt chưa. Nếu biến được đặt, ADC sử dụng tệp tài khoản dịch vụ mà biến trỏ đến.

  2. Nếu biến môi trường không được đặt, ADC sẽ sử dụng tài khoản dịch vụ mặc định mà Compute Engine, Kubernetes Engine, App Engine và Cloud Functions cung cấp cho các ứng dụng chạy trên các dịch vụ đó.

  3. Nếu ADC không thể sử dụng một trong hai thông tin đăng nhập trên, hệ thống sẽ báo lỗi.

Ví dụ về mã SDK quản trị viên sau đây minh họa chiến lược này. Ví dụ không chỉ định rõ ràng thông tin đăng nhập ứng dụng. Tuy nhiên, ADC có thể ngầm hiểu thông tin đăng nhập miễn là biến môi trường được đặt hoặc miễn là ứng dụng đang chạy trên Compute Engine, Kubernetes Engine, App Engine hoặc Cloud Functions.

Node.js

admin.initializeApp({
  credential: admin.credential.applicationDefault(),
});

Java

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

FirebaseApp.initializeApp(options);

Python

default_app = firebase_admin.initialize_app()

Đi

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(),
});

Cung cấp thông tin xác thực theo cách thủ công

Các dự án Firebase hỗ trợ tài khoản dịch vụ của Google, bạn có thể sử dụng tài khoản này để gọi các API máy chủ Firebase từ máy chủ ứng dụng hoặc môi trường đáng tin cậy của mình. Nếu bạn đang phát triển mã cục bộ hoặc triển khai ứng dụng của mình tại chỗ, bạn có thể sử dụng thông tin đăng nhập có được qua tài khoản dịch vụ này để cho phép các yêu cầu máy chủ.

Để xác thực tài khoản dịch vụ và cho phép tài khoản đó truy cập các dịch vụ Firebase, bạn phải tạo tệp khóa cá nhân ở định dạng JSON.

Để tạo tệp khóa riêng tư cho tài khoản dịch vụ của bạn:

  1. Trong bảng điều khiển Firebase, mở Cài đặt> Tài khoản dịch vụ .

  2. Nhấp vào Tạo khóa riêng tư mới , sau đó xác nhận bằng cách nhấp vào Tạo khóa .

  3. Lưu trữ an toàn tệp JSON có chứa khóa.

Khi ủy quyền qua tài khoản dịch vụ, bạn có hai lựa chọn để cung cấp thông tin đăng nhập cho ứng dụng của mình. Bạn có thể đặt biến môi trường GOOGLE_APPLICATION_CREDENTIALS hoặc bạn có thể chuyển rõ ràng đường dẫn tới khóa tài khoản dịch vụ trong mã. Tùy chọn đầu tiên là an toàn hơn và được khuyến khích.

Để đặt biến môi trường:

Đặt biến môi trường GOOGLE_APPLICATION_CREDENTIALS thành đường dẫn tệp của tệp JSON có chứa khóa tài khoản dịch vụ của bạn. Biến này chỉ áp dụng cho phiên shell hiện tại của bạn, vì vậy nếu bạn mở một phiên mới, hãy đặt lại biến.

Linux hoặc macOS

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

các cửa sổ

Với PowerShell:

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

Sau khi bạn đã hoàn thành các bước trên, Thông tin đăng nhập mặc định của ứng dụng (ADC) có thể xác định ngầm thông tin đăng nhập của bạn, cho phép bạn sử dụng thông tin đăng nhập tài khoản dịch vụ khi thử nghiệm hoặc chạy trong môi trường không phải của Google.

Sử dụng thông tin đăng nhập để đúc mã thông báo truy cập

Sử dụng thông tin đăng nhập Firebase của bạn cùng với Thư viện ứng dụng khách API của Google cho ngôn ngữ ưa thích của bạn để truy xuất mã thông báo truy cập OAuth 2.0 tồn tại trong thời gian ngắn:

node.js

 function getAccessToken() {
  return new Promise(function(resolve, reject) {
    const key = require('../placeholders/service-account.json');
    const jwtClient = new google.auth.JWT(
      key.client_email,
      null,
      key.private_key,
      SCOPES,
      null
    );
    jwtClient.authorize(function(err, tokens) {
      if (err) {
        reject(err);
        return;
      }
      resolve(tokens.access_token);
    });
  });
}

Trong ví dụ này, thư viện ứng dụng Google API xác thực yêu cầu bằng mã thông báo web JSON hoặc JWT. Để biết thêm thông tin, hãy xem mã thông báo web JSON .

Python

def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      'service-account.json', SCOPES)
  access_token_info = credentials.get_access_token()
  return access_token_info.access_token

Java

private static String getAccessToken() throws IOException {
  GoogleCredential googleCredential = GoogleCredential
      .fromStream(new FileInputStream("service-account.json"))
      .createScoped(Arrays.asList(SCOPES));
  googleCredential.refreshToken();
  return googleCredential.getAccessToken();
}

Sau khi mã thông báo truy cập của bạn hết hạn, phương thức làm mới mã thông báo được gọi tự động để truy xuất mã thông báo truy cập đã cập nhật.

Để cấp quyền truy cập vào FCM, hãy yêu cầu phạm vi https://www.googleapis.com/auth/firebase.messaging .

Để thêm mã thông báo truy cập vào tiêu đề yêu cầu HTTP:

Thêm mã thông báo làm giá trị của tiêu đề Authorization ở định dạng Authorization: Bearer <access_token> :

node.js

headers: {
  'Authorization': 'Bearer ' + accessToken
}

Python

headers = {
  'Authorization': 'Bearer ' + _get_access_token(),
  'Content-Type': 'application/json; UTF-8',
}

Java

URL url = new URL(BASE_URL + FCM_SEND_ENDPOINT);
HttpURLConnection httpURLConnection = (HttpURLConnection) url.openConnection();
httpURLConnection.setRequestProperty("Authorization", "Bearer " + getAccessToken());
httpURLConnection.setRequestProperty("Content-Type", "application/json; UTF-8");
return httpURLConnection;

Cập nhật khối lượng yêu cầu gửi

FCM HTTP v1 giới thiệu một thay đổi đáng kể trong cấu trúc của tải trọng thông báo JSON. Về cơ bản, những thay đổi này đảm bảo rằng các thư được xử lý chính xác khi nhận được trên các nền tảng khách hàng khác nhau; ngoài ra, các thay đổi giúp bạn linh hoạt hơn để tùy chỉnh hoặc "ghi đè" các trường thông báo trên mỗi nền tảng.

Ngoài việc kiểm tra các ví dụ trong phần này, hãy xem Tùy chỉnh thông báo trên các nền tảng và xem lại tham chiếu API để làm quen với HTTP v1.

Ví dụ: tin nhắn thông báo đơn giản

Đây là một sự so sánh của một thông báo rất đơn giản payload- chứa title , bodydata lĩnh vực only- thể hiện sự khác biệt cơ bản trong di sản và HTTP v1 trọng tải.

Trước

{
  "to": "/topics/news",
  "notification": {
    "title": "Breaking News",
    "body": "New news story available."
  },
  "data": {
    "story_id": "story_12345"
  }
}

Sau

{
  "message": {
    "topic": "news",
    "notification": {
      "title": "Breaking News",
      "body": "New news story available."
    },
    "data": {
      "story_id": "story_12345"
    }
  }
}

Ví dụ: nhắm mục tiêu nhiều nền tảng

Để bật tính năng nhắm mục tiêu đa nền tảng, API kế thừa đã thực hiện ghi đè trong phần phụ trợ. Ngược lại, HTTP v1 cung cấp các khối khóa dành riêng cho nền tảng giúp tạo ra bất kỳ sự khác biệt nào giữa các nền tảng một cách rõ ràng và hiển thị cho nhà phát triển. Điều này cho phép bạn nhắm mục tiêu nhiều nền tảng luôn với một yêu cầu duy nhất, như được minh họa trong mẫu sau.

Trước

// Android
{
  "to": "/topics/news",
  "notification": {
    "title": "Breaking News",
    "body": "New news story available.",
    "click_action": "TOP_STORY_ACTIVITY"
  },
  "data": {
    "story_id": "story_12345"
  }
}
// iOS
{
  "to": "/topics/news",
  "notification": {
    "title": "Breaking News",
    "body": "New news story available.",
    "click_action": "HANDLE_BREAKING_NEWS"
  },
  "data": {
    "story_id": "story_12345"
  }
}

Sau

{
  "message": {
    "topic": "news",
    "notification": {
      "title": "Breaking News",
      "body": "New news story available."
    },
    "data": {
      "story_id": "story_12345"
    }
    "android": {
      "notification": {
        "click_action": "TOP_STORY_ACTIVITY"
      }
    },
    "aps": {
      "payload": {
        "aps": {
          "category" : "NEW_MESSAGE_CATEGORY"
        }
      }
    }
  }
}

Ví dụ: tùy chỉnh bằng ghi đè nền tảng

Ngoài việc đơn giản hóa việc nhắm mục tiêu thông báo trên nhiều nền tảng, API HTTP v1 cung cấp tính linh hoạt để tùy chỉnh thông báo trên mỗi nền tảng.

Trước

// Android
{
  "to": "/topics/news",
  "notification": {
    "title": "Breaking News",
    "body": "Check out the Top Story.",
    "click_action": "TOP_STORY_ACTIVITY"
  },
  "data": {
    "story_id": "story_12345"
  }
}
// iOS
{
  "to": "/topics/news",
  "notification": {
    "title": "Breaking News",
    "body": "New news story available.",
    "click_action": "HANDLE_BREAKING_NEWS"
  },
  "data": {
    "story_id": "story_12345"
  }
}

Sau

{
  "message": {
    "topic": "news",
    "notification": {
      "title": "Breaking News",
      "body": "New news story available."
    },
    "data": {
      "story_id": "story_12345"
    },
    "android": {
      "notification": {
        "click_action": "TOP_STORY_ACTIVITY",
        "body": "Check out the Top Story"
      }
    },
    "apns": {
      "payload": {
        "aps": {
          "category" : "NEW_MESSAGE_CATEGORY"
        }
      }
    }
  }
}

Để biết thêm mẫu và thông tin về API FCM HTTP v1, hãy xem Blog Firebase .