newsdaycom/stackpath-php-sdk

Stackpath 的 PHP SDK

1.2.0 2021-01-08 18:03 UTC

README

此包是为了使PHP中连接StackPath API更容易而编写的。我们将根据我们的需求维护它,并主要目标是向其中添加清除请求逻辑,我们已经做到了。

随着需求,还将提供其他抽象方法。

此包是开源的,我们欢迎对新功能的pull请求。

安装

您可以通过运行以下命令轻松将其添加到项目中

composer require newsdaycom/stackpath-php-sdk

配置

为了简单起见,我们鼓励您设置两个环境变量,STACKPATH_IDSTACKPATH_SECRET。如果您不能这样做,您也可以在实例化时作为参数提供client_id和client_secret。OAuth握手发生在实例化时,默认情况下所有请求都提供bearer token。

使用

要使用Stackpath,您必须首先实例化该类,并包含您的client_id、client_secret和stack_id;

$sp = new \StackPath\StackPath("9ad4bdfc-77ec-41bb-ac95-da137d837742", $CLIENT_ID, $CLIENT_SECRET);

如果您没有提供$CLIENT_ID或$CLIENT_SECRET,类将回退到您的环境变量。

默认情况下已设置请求方法,GETPOSTDELETEPUT。这些都是request方法的简写方法,它处理所有授权、有效负载和将响应作为对象返回的逻辑。此应用程序中的请求由Guzzle提供支持。

您提供的URL应该以API调用中的https://gateway.stackpath.com之后的内容开始。网关将自动填充。也可以使用绝对URL。

例如,请求令牌可以这样做

$this->post("identity/v1/oauth2/token", ["json" => [
          "client_id" => $this->creds["client_id"],
          "client_secret" => $this->creds["client_secret"],
          "grant_type" => "client_credentials"
        ]])->access_token

注意,响应将以对象的形式返回,因此您可以像处理方法一样处理它。您发送到Stackpath的大多数有效负载都可以以以下方式开始

["json" => [ARRAY OF DATA]]

文档

在撰写此README时,文档可以在src/StackPath/StackPath.php中的PHPDoc注释符号中找到。如果您有这里未回答的问题,请通过GitHub问题进行联系。

祝您玩得开心!