flagrow/flarum-api-client

此包已被弃用，不再维护。作者建议使用 maicol07/flarum-api-client 包代替。

用于调用 Flarum 安装 API 的独立包。

维护者

详细信息

github.com/flagrow/flarum-api-client

源代码

问题

安装数: 4,617

依赖: 0

建议者: 0

安全: 0

星标: 25

关注者: 4

分支: 11

开放问题: 6

0.2.0-beta.2 2017-03-04 22:08 UTC

Requires

Requires (Dev)

MIT 4217e8cbd8070d9a981bf3bb2d112b5ce51cb3d5

apiflarumflagrow

This package is auto-updated.

Last update: 2020-08-27 07:50:27 UTC

README

Latest Stable Version Gitter

这是一个通用的 PHP API 客户端，适用于任何项目。您可以将此包作为依赖项添加到项目中以使用它。

安装

composer require flagrow/flarum-api-client

配置

为了开始使用客户端，您可能需要一个 Flarum 主密钥

  1. 生成一个 40 个字符的随机、不可猜的字符串，这是此包所需的 Token。
  2. 请手动使用 phpmyadmin/adminer 或其他解决方案将其添加到 api_keys 表中。

主密钥是访问非公开讨论和执行保留给 Flarum 管理员的操作的必需项。

示例

基本示例

<?php

require_once "vendor/autoload.php";

use Flagrow\Flarum\Api\Flarum;

$api = new Flarum('http://example.com');

// A collection of discussions from the first page of your Forum index.
$discussions = $api->discussions()->request();
// Read a specific discussion.
$discussion = $api->discussions()->id(1)->request();
// Read the first page of users.
$users = $api->users()->request();

授权示例

$api = Flarum('http://example.com', ['token' => '<insert-master-token>; userId=1']);

userId 指的是具有管理员权限的用户或您要为其执行操作的用户。仅将 userId 设置附加到 Token 仅适用于主密钥。

链接

Flagrow 是 Flarum 扩展开发者的协作，旨在提供高质量、维护良好的扩展。