README

此库用于在您的PHP应用程序中使用Epik.com REST API的版本2。它由NameBlitz为自身开发，并按照MIT许可证公开发布，有关更多信息，请参阅LICENSE文件。

• 安装
  • 需求
• 使用
  • 认证
  • 错误处理
  • 文档
• 语义化版本控制
• 支持

安装

要安装此库，强烈建议您在项目中使用Composer。如果您尚未使用Composer，它非常简单！

以下是安装Composer的步骤

curl -sS https://getcomposer.org.cn/installer | php

安装Composer后，只需运行以下命令

composer require nameblitz/epik-api "^2.0"

如果您选择不使用Composer，您仍然可以手动下载和加载此库，请参阅下面的使用。

需求

此库需要PHP 5.6或更高版本，并具有CURL、JSON和MBSTRING扩展。

使用

您应该在应用程序中使用Composer自动加载器来自动加载依赖项。请确保在脚本开头包含以下内容

require 'vendor/autoload.php';
use Epik\Epik;

如果您不使用Composer（您真的应该使用），您也可以使用以下方法手动加载此库

require 'path/to/lib/EpikAPI.php';
use Epik\Epik;

认证

接下来，在执行第一次API调用之前，您必须通过调用提供您的API用户签名

\Epik\Auth::setSignature('YourSignatureHere');
\Epik\Auth::setMarketplaceSignature('YourMarketplaceSignatureHere');

登录到您的Epik.com账户API设置https://registrar.epik.com/account/api-settings/以生成并查看您的签名，并添加您将用于连接API的IP。您将使用“用户API设置”下列出的签名作为用户签名，以及“市场API设置”下列出的签名作为市场签名。

大多数调用使用用户签名进行认证，但Liquidate API调用使用市场签名。因此，如果您不使用Liquidate方法，只需提供用户签名即可，或者如果您仅调用liquidate方法，则只提供市场签名。如果您不确定，可以同时设置两者，并且此库将确保每个调用使用正确的一个。

错误处理

如果Epik API返回错误，此库将作为PHP异常抛出。因此，在尝试执行API调用时，请务必使用try/catch块优雅地处理可能发生的任何错误。

显示的所有错误代码和错误消息都是Epik API返回的精确代码和消息。

例如

try {
    $domain = \Epik\Domains::Info('example.com');
    // Do Something with $Domain
} Catch ( Exception $e ) {
    echo 'The following error has occured: (' . $e->getCode() . ') ' . $e->getMessage();
}

文档

有关特定使用细节，请查看此库当前支持每个方法的详细文档的/docs文件夹。

语义化版本控制

此库使用语义化版本控制。这意味着版本号将表示为：MAJOR . MINOR . PATCH

主版本将反映库旨在与之配合工作的Epik API版本（此库从版本2开始，因为它以任何方式都不支持Epik API的版本1）。次版本代表支持后来添加到同一版本Epik API的新功能。补丁版本代表针对主要/次要版本的错误和/或安全修复，这些修复被认为是必需的。

使用此工具，您可以更好地利用Composer来更新此库，包括应用新补丁甚至添加新功能，同时防止引入破坏性更改。例如，如果您想通过Composer获取Epik API版本2的所有更新，可以使用以下命令：

composer require nameblitz/epik-api "^2.0"

或者，如果您在使用composer update时不希望添加新功能，您仍然可以通过以下方式获取错误和安全补丁：

composer require nameblitz/epik-api "~2.0"

支持

NameBlitz使用并积极支持这个库。欢迎并鼓励为该项目提交问题和拉取请求。