README

用于与 Crashplan API 交互的 PHP 客户端。

随着功能的需要，我们逐步构建这个客户端。最初我们只需要它来管理用户账户。

此客户端基于Guzzle（PHP HTTP 客户端）。Guzzle 提供了一种简单的方法来创建 API 客户端，通过使用类似 Swagger 的格式描述 API，无需自行实现每个方法。因此，添加对更多 Crashplan API 的支持相对简单。如果您想提交拉取请求以添加另一个功能，请这样做。如果您不知道如何操作，请向我们提问，我们可能会为您添加它。

Crashplan API 认证

Crashplan 使用基本认证来验证 API 调用。您必须通过参数 apiuser 和 apipass 提供您的 API 用户的用户名和密码。

安装

使用 Composer 进行安装非常简单。将 "silinternational/crashplan-php-client": "dev-master" 添加到您的 composer.json 文件中，并更新。

使用方法

示例

<?php

use Crashplan\Client;

$client = new Client([
  'apiuser' => 'username',
  'apipass' => 'password',
]);

$user = $client->getUser(['userId' => 123456789]);

echo $user['email'];
// example@domain.org

$newUser = $client->addUser([
  "email" => "test_user@domain.org",
  "username" => "test_user",
  "firstName" => "test",
  "lastName" => "user",
  "orgId" => 123,
  "password" => "newpassword",
]);

echo $user['data']['userId'];
// 1234567890

如果您托管自己的 Crashplan Enterprise 服务器，您可以覆盖默认的 API URL

<?php

use Crashplan\Client;

$client = new Client([
  'apiuser' => 'username',
  'apipass' => 'password',
  'description_override' => [
    'baseUrl' => 'https://my.server.com',
  ],
]);

Guzzle 服务客户端备注

由 Jeremy Lindblom 演示： https://speakerdeck.com/jeremeamia/building-web-service-clients-with-guzzle-1
由 Jeremy Lindblom 提供的示例： https://github.com/jeremeamia/sunshinephp-guzzle-examples
源代码注释中的参数文档： https://github.com/guzzle/guzzle-services/blob/master/src/Parameter.php

silinternational / crashplan-php-client

维护者

详情

README

Crashplan API 认证

安装

使用方法

Guzzle 服务客户端备注