README

安装

首先，使用 composer 安装包

composer require statikbe/udb-helpers

然后，您可以使用以下参数实例化 EntryAPI 类

use statikbe\udb\EntryAPI;
use statikbe\udb\Environments;

$udb = new EntryAPI(
    getenv("UDB_KEY"), // API key
    '/var/www/path/to/your/jwt/token.json', // Path to where you're JWT token will be stored
    Environments::PROD // The package includes an enum for that sets endpoints based in environment
);

认证

要使用 UDB 进行认证，您需要一个 JWT 令牌。您可以通过以下命令生成获取该令牌的 URL

$url = $udb->api->generalJwtUrl();
echo $url; 
exit;

上面的代码将输出一个 URL。将此 URL 粘贴到浏览器窗口中，然后您将被提示使用您的 UiT-ID 登录。登录后，您将看到一个空白屏幕，显示“内部服务器错误”。

您可以在该页面的 URL 中找到访问令牌和刷新令牌。

将两个令牌保存在上面指定的 json 文件中，格式如下

{
  "accessToken": "",
  "refreshToken": ""
}

用法

一旦您通过 API 进行了认证，您可以使用以下函数

搜索地点

$udb->searchPlaces([]);

该函数接受一个可能的搜索参数数组，这些参数可以在这里找到

获取特定地点的所有详细信息

$udb->getPlace($placeId);

创建地点

传递的数据应该是一个数组，其中包含与地点模型匹配的字段。

$udb->createPlace($data);

搜索组织者

$udb->searchOrganizers([]);

该函数接受一个可能的搜索参数数组，这些参数可以在这里找到

获取特定组织者的所有详细信息

$udb->getOrganizer($organizerId);

创建组织者

传递的数据应该是一个数组，其中包含与组织者模型匹配的字段。

$udb->createOrganizer($data);

创建活动

传递的数据应该是一个数组，其中包含与活动模型匹配的字段。

$udb->createEvent($data);

更新活动

传递的数据应该是一个数组，其中包含与活动模型匹配的字段。

$udb->updateEvent($eventId, $data);

更新活动的 workflowStatus

传递的数据应该是一个数组，其中包含与workflowStatus 模型匹配的字段。

$udb->updateWorkflowStatus($eventId, $data);

更新地点的 workflowStatus