README

Pirac 可以用来轻松地与 ISVU REST API v2 通信。

安装

将以下行添加到您的 composer.json 文件中

"require": {
    "cicnavi/pirac": "dev-master"
}

接下来，运行 composer update 命令。

配置

Pirac 使用由 Vance Lucas 开发的 DotEnv PHP 库。在您应用程序的根目录中，您必须创建一个 .env 文件。在 .env 文件中，Pirac 将查找以下两个变量

ISVU_USERNAME=exampleusername
ISVU_PASSWORD=examplepassword

请确保将您的 ISVU REST API 用户名和密码分配给这些变量，因为这些将在对 ISVU REST API 的每次请求中使用。我们建议您将生产 API 凭证输入到这两个变量中。您也可以为测试 API 设置凭证。如果您想使用测试 API，也请添加以下变量

ISVU_USE_TEST_API=true
ISVU_TEST_USERNAME=someTestUserName
ISVU_TEST_PASSWORD=someTestPassword

重要提示：您的 .env 文件不应该提交到您应用程序的源代码控制中！

使用方法

Pirac 使用 nategood 的 Httpful 向 ISVU REST API 发送请求。返回的资源将是 PHP stdClass 的实例。Httpful 使用 cURL 组件，因此请确保您已安装并启用它。

通常，您可以使用 Pirac 与单个机构的 ISVU REST API 通信。我们现在能做的第一件事是获取可用的起始资源及其链接。我们可以用以下行完成

$pirac->getIndex();

这将返回包含其链接的可用资源。我们可以使用这些链接在其他 Pirac 方法中

$pirac->get('url');

默认情况下，Pirac 使用 "application/hal+json" 作为 Accept HTTP 头。这可以通过作为第二个参数提供包含头部的数组来更改。通过设置适当的 Accept 头部，我们可以实际上使用 ISVU REST API 版本 1。例如，要使用 ISVU REST API v1，我们可以将 'application/xml' 作为 Accept 头部输入

$pirac->get('url', ['Accept' => 'application/xml']);

有关更多信息，请参阅 ISVU REST API 文档。

示例

        use Pirac\Pirac;

        // Create Pirac instance.
        $pirac = new Pirac();

        // Get index links.
        $indexLinks = $pirac->getIndex();

        // Get specific resource.
        $nastavniplan = $pirac->get($indexLinks->nastavniplan->href);

多机构 API

如果您有权访问多机构 API，您可以使用 getIndex() 方法获取所有可用机构的列表。这将返回包含所有机构的数组。

$allInstitutions = $pirac->getIndex();

然而，如果您使用单个机构 API，getIndex() 方法将返回一个包含可用资源和其链接的 stdClass 对象。

许可

Pirac 是在 MIT 许可证 下开源的软件