README

简介

欢迎使用 ExaVault 的 v2 API PHP 代码库。我们的 v2 API 将允许您以与我们的网页门户相同的方式与服务的所有方面进行交互。该库是由我们的 API 的公共 Swagger YAML 文件生成的。

关于 Guzzle 的重要说明

当您的项目需要与版本 6 不同的 Guzzle 版本时，应使用此库。我们已经将 Guzzle 库的引用更新为使用版本 6.5.5，该版本已包含在 vendor-static 子目录中。如果您的项目不需要不同版本的 Guzzle，请改用我们的常规 PHP 库。

要求

要使用此库，您需要安装 PHP 5.5（或更高版本）以及 composer。

您还需要一个 ExaVault 账户、API 密钥和访问令牌。

安装代码库

选项 1 - 使用 Composer

您可以在项目文件夹中运行此命令将此库添加到您的项目中

% composer require exavault/evapi-php-guzzle-compat

选项 2 - 手动安装

或者，您可以克隆 github 仓库，然后在 evapi-php-guzzle-compat 目录中运行 composer install 以安装依赖项。

示例代码

要了解如何使用 PHP 代码与 ExaVault 的 API 交互，请查看我们的代码示例。按照该存储库 README 中的说明运行示例脚本，这些脚本将演示如何使用生成的几个 PHP 类与您的 ExaVault 账户进行交互。

编写您的代码

当您准备好使用此库编写自己的代码时，您需要

在您的项目中安装我们的代码库，使用 composer require exavault/evapi-php-guzzle-compat 或下载此存储库并运行 composer install
在您的脚本顶部包含生成的 vendor/autoload.php
在 ExaVault\Api 命名空间中的 Api 类的每个函数方法上提供您的 API 密钥和访问令牌
每次实例化 Api 对象（ResourcesApi、UsersApi 等）时，请覆盖配置以指向正确的 API URL

// Replace YOUR_ACCOUNT_NAME_HERE with your account name!
$account_url = "https://YOUR_ACCOUNT_NAME_HERE.exavault.com/api/v2/";
$accountApi = new ExaVault\Api\AccountApi(
    null,
    (new ExaVault\Configuration())->setHost($account_url)
);

$resourcesApi = new ExaVault\Api\ResourcesApi(
    null,
    (new ExaVault\Configuration())->setHost($account_url)
);

$usersApi = new ExaVault\Api\UsersApi(
    null,
    (new ExaVault\Configuration())->setHost($account_url)
);

如果您想看到示例代码，请查看我们的代码示例。

作者

support@exavault.com

exavault / evapi-php-guzzle-compat

维护者

详细信息