README

Rustici Engine API

此 PHP 包是由 Swagger Codegen 项目自动生成的

API 版本：2.0
构建包：io.swagger.codegen.languages.PhpClientCodegen

需求

PHP 5.5 及更高版本

安装与使用

Composer

要使用 Composer 安装绑定，请将以下内容添加到 composer.json

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/amandiobm/rustici-engine-api-v2-client-php.git"
    }
  ],
  "require": {
    "amandiobm/rustici-engine-api-v2-client-php": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

    require_once('/path/to/SwaggerClient-php/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门

请按照安装说明进行操作，然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: basic
$config = RusticiSoftware\Engine\V2\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');
// Configure OAuth2 access token for authorization: oauth
$config = RusticiSoftware\Engine\V2\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new RusticiSoftware\Engine\V2\Api\AboutApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$engine_tenant_name = "engine_tenant_name_example"; // string | optional tenant for this request

try {
    $result = $apiInstance->getAbout($engine_tenant_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AboutApi->getAbout: ', $e->getMessage(), PHP_EOL;
}

?>

API 端点文档

所有 URI 都是相对于 https:///api/v2/

模型文档

授权文档

基本

类型：HTTP基本身份验证

oauth

类型：OAuth
流程：隐式
授权URL：/authorize
作用域:
read：授予读取访问权限
write：授予写入访问权限
delete：授予删除访问权限
admin：授予读取、写入和账户管理访问权限
admin:read：授予只读管理员访问权限
admin:createTenant：授予租户创建访问权限
admin:deleteData：授予删除整个租户数据或进行PII删除的能力
admin:writeConfiguration：授予写入管理配置设置权限
admin:writeCredential：授予创建凭证的能力
admin:connector：授予管理内容连接器的访问权限
read:connectorContent：授予读取可用内容连接器列表的访问权限
read:course：授予读取课程资源的访问权限
write:course：授予写入课程资源的访问权限
delete:course：授予删除课程资源的访问权限
read:dispatch：授予读取调派资源的访问权限
write:dispatch：授予写入调派资源的访问权限
delete:dispatch：授予删除调派资源的访问权限
read:ping：授予读取ping资源的访问权限
read:about：授予读取about资源的访问权限
read:registration：授予读取注册资源的访问权限
write:registration：授予写入注册资源的访问权限
delete:registration：授予删除注册资源的访问权限
read:xapicredential：授予读取xapi凭证资源的访问权限
write:xapicredential：授予写入xapi凭证资源的访问权限
delete:xapicredential：授予删除xapi凭证资源的访问权限
read:xapipipe：授予读取xapi管道资源的访问权限
write:xapipipe：授予写入xapi管道资源的访问权限
delete:xapipipe：授予删除xapi管道资源的访问权限
configure:server：在管理配置时包括服务器管理员设置
request:secrets：授予读取加密配置设置的访问权限
write:player：授予写入玩家资源的访问权限
read:player：授予读取玩家资源的访问权限
read:contentVault：授予读取内容库资源的访问权限
笔：收集：允许进行 PENS 收集请求的访问

amandiobm / rustici-engine-api-v2-client-php

维护者

详细信息