README

此SDK是一个开源的PHP库，可以轻松地将您的PHP应用程序与PlayerLync REST API集成

PHP PlayerLync SDK入门指南

自动加载与命名空间

PHP PlayerLync SDK符合PSR-4规范，这意味着它依赖于命名空间，以便可以自动加载类文件。

系统要求

• PHP 5.5或更高版本

安装PHP PlayerLync SDK

安装PHP PlayerLync SDK有两种方法。推荐的方法是使用Composer。如果您无法在项目中使用Composer，您仍然可以通过下载源文件并包含自动加载器手动安装SDK。

使用Composer安装（推荐）

Composer是推荐安装PHP PlayerLync SDK的方法。只需将以下“require”条目添加到项目根目录中的composer.json文件中。

{
  "require" : {
    "playerlync/playerlync-sdk-php" : "4000.1.*"
  }
}

然后从命令行运行composer install，Composer将下载SDK的最新版本并将其放入/vendor/目录中。

确保在脚本顶部包含Composer自动加载器。

require_once __DIR__ . '/vendor/autoload.php';

不使用Composer加载SDK

如果您不使用Composer，您可以从我们的GitHub下载SDK： playerlync-sdk-php

按照这种方式加载SDK

define('PLAYERLYNC_SDK_PHP_SRC_DIR', '/path/to/playerlync-sdk-php/src/PlayerLync/');
require __DIR__ . '/path/to/playerlync-sdk-php/vendor/autoload.php';

配置和设置

这假设您已经通过PlayerLync管理门户为您的主要组织配置了PlayerLync API访问。这也假设您有一个有效的PlayerLync用户帐户，该帐户也有权访问已经配置API访问的主要组织。

在我们可以向PlayerLync API发送请求之前，我们需要将我们的应用程序配置加载到PlayerLync\PlayerLync服务中。

$playerlync = new \PlayerLync\PlayerLync([
        'host' => '{host}',
        'client_id' => '{client-id}',
        'client_secret' => '{client-secret}',
        'username' => '{username}',
        'password' => '{password}',
    ]);

您需要将{host}替换为PlayerLync服务运行的主机（包括方案和端口）（例如：https://tenantname-services.playerlync.com:33322）。用您PlayerLync API访问配置提供的值替换{client-id}和{client-secret}，并替换{username}和{password}为具有访问创建API访问配置的主要组织帐户。

身份验证

PlayerLync API依赖于OAuth 2.0进行身份验证。PlayerLync\PlayerLync服务通过SDK中的辅助类处理请求和续订OAuth令牌，前提是提供了有效的配置。所有对PlayerLync API的请求都需要访问令牌。

向PlayerLync API发送请求

一旦您有了PlayerLync\PlayerLync服务的实例并获取了访问令牌，您就可以开始调用PlayerLync API了。

在这个示例中，我们将向PlayerLync API端点/memebers发送GET请求。/members端点将返回一个数组，表示与访问令牌关联的组织成员集合。

try
{
  $playerlync = new \PlayerLync\PlayerLync([/*.....*/]);

  $response = $playerlync->get('/members', ['limit'=>50]);
  $members = $response->getData();

  echo 'API returned '. count($members) . ' members!';
}
catch(PlayerLync\Exceptions\PlayerLyncResponseException $e)
{
  // When PlayerLync API returns an error
  echo 'PlayerLync API returned an error: ' . $e->getMessage();
  exit;
}
catch(PlayerLync\Exceptions\PlayerLyncSDKException $e)
{
  // When PlayerLync SDK fails or some other local issue
  echo 'PlayerLync SDK returned an error: ' . $e->getMessage();
  exit;
}

在下一个示例中，我们将向PlayerLync API端点/files发送POST请求，以上传/替换PlayerLync内容系统中的现有文件。

try
{
  $playerlync = new \PlayerLync\PlayerLync([/*.....*/]);

  //FILE UPLOAD EXAMPLE
  $existingFileId = '<fileID GUID>';
  $filePath = '/path/to/your/file.txt';

  $data = [
      'fileid' => $existingFileId,
      'sourcefile' => $playerlync->fileToUpload($filePath)
  ];

  $response = $playerlync->post('/files', $data);

  $body = $response->getDecodedBody(); //get the full decoded JSON response
  $file = $response->getData(); //get just the "data" object from the decoded JSON response
}
catch(PlayerLync\Exceptions\PlayerLyncResponseException $e)
{
  // When PlayerLync API returns an error
  echo 'PlayerLync API returned an error: ' . $e->getMessage();
  exit;
}
catch(PlayerLync\Exceptions\PlayerLyncSDKException $e)
{
  // When PlayerLync SDK fails or some other local issue
  echo 'PlayerLync SDK returned an error: ' . $e->getMessage();
  exit;
}