README

此包是iSAMS（https://isams.com）的PHP包装器，使用其REST API。它将API返回的json对象转换为模型实例。

请参阅他们的API文档和https://developerdemo.isams.cloud/Main/swagger/ui/index & https://developer.isams.com/display/PRA/Getting+started+-+REST+API

安装和用法

此包需要PHP 8.1和Laravel 9.0或更高版本。请参阅tests/文件夹中的文档。（我们非常希望有人编写一些正式的文档）

基本安装

您可以通过Composer使用以下命令安装此包：

composer require spkm/isams

该包将自动注册其服务提供者

要发布配置文件到config/isams.php，请运行：

php artisan vendor:publish --provider="spkm\isams\IsamsServiceProvider"

更新配置文件并将REST API密钥添加到您的.env文件中

如果您正在使用School模型，实现接口\spkm\isams\Contracts\Institution

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class School extends Model implements \spkm\isams\Contracts\Institution
{
    /**
     * Define the name used to identify this Schools entry in the config
     */
    public function getConfigName(): string
    {
        return 'cranleighSandbox';
    }
}

在您的config/isams.php文件中，将以下内容添加到schools数组中

    'cranleighSandbox' => [
        'api_key' => env('ISAMS_API_KEY'),
        'api_secret' => env('ISAMS_API_SECRET'),
        'api_url' => env('ISAMS_API_URL'),
    ],

否则，在您的自定义类中实现该接口（或复制示例spkm\isams\School）

测试

composer test

变更日志

请参阅CHANGELOG了解最近更改的更多信息。

贡献

请参阅CONTRIBUTING了解详细信息。

安全性

如果您发现任何安全相关的问题，请通过电子邮件spkm@cranleigh.org而不是使用问题跟踪器。

鸣谢

许可

MIT许可证（MIT）。请参阅许可文件了解更多信息。

spkm / isams

维护者

详细信息

README

安装和用法

基本安装

测试

变更日志

贡献

安全性

鸣谢

许可