README

这个 PHP Composer 包是一个用于与 PrayerMate 平台交互的 API。

PrayerMate 是一款帮助您祷告的应用，此 API 允许您与平台进行交互。

安装

composer install prayermate/prayermate-api

使用方法

您需要从 prayermate.net 门户获取四条信息。

登录到门户。
如果您还没有创建，请创建一个订阅源。
点击订阅源右侧菜单底部的 API 访问。
滚动到 HTTP 请求部分。
在基本授权部分，复制您的 $apiKey（60个字符的十六进制字符串）和 $password（60个字符的十六进制字符串）。
在新内容发布部分，从 json 块的值中复制 $feedID（整数）和 $feedSlug（38个字符的十六进制字符串）。

$apiKey 和 $password 是您账户的全球值，用于访问 API。而 $feedID 和 $feedSlug 对于每个订阅源都是唯一的。

$driver = new Driver\GuzzleDriver($apiKey, $password, $email);
$prayermate = new PrayerMateAPI($driver);

一个请愿是一块内容：订阅源中的祈祷请求。它可以是以纯文本形式，或者如果您在门户的 API 访问页面底部点击按钮启用了 Markdown，则可以是以 Markdown 格式。

查看您的订阅源中的内容

$petitions = $prayermate->getFeedContents($feedSlug);

向订阅源添加新的请求

$petition = new Petition('My prayer *Request* content', '2018-10-11');
$petition->setTitle('A test request');
$petition->setIsMarkdown();
$prayermate->setFeedContents($feedSlug, $feedID, gmdate('Y-m-d H:i:s'), [$petition]);

请注意，订阅源可以有几种不同的“样式”（配置），例如日历、通讯简报、每月某日，您在创建时选择。有关更多详细信息，请参阅 prayermate.net 上的文档。注意没有日期的 请愿。这些是“独占”的，这意味着它们会替换订阅源中的所有其他请愿。这对于每天推送更新且不关心历史数据的 API 非常有用。请仔细阅读您的订阅源的 API 页面上的文档，了解如何处理多个请愿。

开发

单元测试 composer phpunit
静态分析 composer phpstan

待办事项

tls 密钥固定
Ruby Gem 版本 https://github.com/andygeers/prayermate_api 有几个其他端点，但我们还没有为这些端点提供文档。

贡献

目前开发和使用是内部的。请联系 info@prayermate.net 以参与其中。

行为准则

PrayerMateApi 项目代码库、问题跟踪器、聊天室和邮件列表中互动的每个人都需要遵守行为准则。

prayermate / prayermate-api

维护者

详细信息

README

安装

使用方法

开发

待办事项

贡献

行为准则