mi5ha/firebase-backend-api

此包已被废弃,不再维护。未建议替代包。

Firebase 后端 API

v1.0.3 2020-10-12 10:40 UTC

This package is auto-updated.

Last update: 2023-04-12 16:36:40 UTC


README

Supported PHP version

一些 Firebase 功能需要您编写服务器应用程序才能使用。

这是一个非常简单的 PHP 应用程序,它公开了一些有用的 API 端点,您可以从您的移动或 Web 应用程序中使用。

目录

概述

  • 例如,从一台设备向多台其他设备发送多个通知,没有服务器应用程序是无法完成的。
  • 此应用程序在底层使用 Firebase Admin SDK for PHP

要求

  • 最低 PHP 版本是 v7.2
  • Apache

安装

创建新项目

composer create-project mi5ha/firebase-backend-api

配置

  • 从 Firebase 下载服务账户密钥 文件
    • 转到“设置 -> 服务账户”
    • 首先点击“创建服务账户”,然后“生成新私钥”
  • 将服务密钥文件放在文档根目录之外的位置
  • 打开 config/config.php,并添加相对于配置文件的密钥文件路径

安全警告

  • 您的服务账户密钥,即您从 Firebase 下载的 json 文件,不应从网络上访问
  • 如果您不小心将此文件放在此项目中,应存在 .htaccess 以阻止用户访问它(仅限 Apache)
  • 目前此应用程序不支持任何类型的 API 身份验证

API

发送所有请求时,请发送此标题

Content-Type: application/json

sendMulticastMessages

从一台设备向多台其他设备发送通知。

示例

POST 请求

http://<your-domain>/?method=sendMulticastMessages

JSON 请求体

{
    "title": "I am Iron Man",
    "deviceTokens": [
        "fqORTS66YYQHKnpSsdf0QIKl:APA91bEggEnA-NDaSRvFtHsdd3UQLw3miPSw0jINjrgg0DdaRUP9u2DXBE6Veq2br9qsmDI5q2S-VnA1SvSmBnrOKMCxyuLzhh0EY2YXvQRqrDL5nf5FC8sjjLAgenLm-voggrtjAdlW",
        "f4fRp143affMgijGpVoj5I:APA91bGaaeqJ1IwtTmVvPVahdzeFbffvXizaL1u2iYGqWDhhht0aJuEFDt-qNHHHTgggUGfrM6qcrwKffFz7Sm-2PMsCFfkjjQjcNDbnn_tOcu9AF0OwGX21aaOpbXCUhhGyy4o5Zcr"
    ],
    "imageUrl": "https://i.insider.com/5b52400e51dfbe20008b45f9?width=750&format=jpeg&auto=webp"
}

成功响应

{
  "success": true
}

错误响应

{
  "success": false,
  "errorMessages": [
    "The registration token is not a valid FCM registration token",
    "The registration token is not a valid FCM registration token"
  ]
}

errorMessages 是每个设备令牌的特定错误消息数组。

您需要获取设备令牌才能使用此方法

例如,从 React Native Firebase,您可以使用 getToken() 获取此令牌

import messaging from '@react-native-firebase/messaging';

let deviceToken = await messaging().getToken();

贡献

欢迎拉取请求。对于主要更改,请首先提出问题以讨论您想要更改的内容。

许可证

Firebase PHP 后端采用 MIT 许可协议 许可。

您对 Firebase 的使用受 Firebase 服务条款 管辖。