gettyimages/connect_sdk

此包已被弃用,不再维护。作者建议使用gettyimages/gettyimages-api包。

Getty Images API SDK - PHP

5.1.1 2024-05-02 15:06 UTC

README

Getty Images API SDK - PHP

Build Status

介绍

此SDK使得使用Getty Images API变得简单。它处理凭证管理、发起HTTP请求,并采用流畅的编写风格。有关API的更多信息,请参阅文档

  • 搜索我们广泛创意和编辑目录中的图片和视频。
  • 获取图片和视频元数据。
  • 使用您的Getty Images产品(例如,编辑订阅、Easy Access、Thinkstock订阅和图片包)下载文件。
  • 自定义请求功能,允许用户调用任何端点。

帮助与支持

入门

获取API密钥

如果您还没有API密钥,请填写并提交联系表单,以便与我们的销售团队取得联系。

安装包

SDK可在Packagist上找到。

示例

有关示例,请参阅example.md

从源代码构建

如果您想为项目做出贡献,则需要源代码。否则,请使用

初始设置

假设

  • 您已设置PHP >=7.2

PHP.ini设置以构建代码

[Phar]
; https://php.ac.cn/phar.readonly
phar.readonly = Off

//Extensions needed for Windows OSs
extension=php_curl.dll
extension=php_mbstring.dll
extension=php_exif.dll
extension=php_sockets.dll
extension=php_openssl.dll

通过Composer安装

请参阅README_ComposerInstall.md

快速构建

如果您已经将所有设置在您的机器上,并且PHP可以运行,则可以运行BuildSDK.bat或Build.sh来自动构建phar。如果出现错误,请阅读错误信息,如果您以前从未尝试使用PHP构建包,则PHP的设置可能会有些棘手。

Windows

build.bat

Linux / OSX

先决条件

在Ubuntu上,您可能需要安装一些额外的包

sudo apt update
sudo apt install php-xml php-mbstring

构建

./build.sh

这将在构建文件夹中将GettyImagesApi.phar放入其中。然后您可以使用该包就像使用任何其他phar一样。

构建会为您自动完成一些事情

  1. 确定您是否具有composer.phar,如果没有,则检索它
  2. 运行composer install以获取在composer.json文件中概述的依赖项
  3. 然后在./build/GettyImagesApi.phar中生成phar文件

手动安装PHP库

BuildSDK应该为您获取所有依赖项,但如果您想从仓库根目录更新而无需构建

php composer.phar install

如果您需要测试依赖项

php composer.phar install --require-dev

此命令应安装PHPUnit和其他PHP依赖库

感兴趣的变量环境

SDK支持直接使用代理以及忽略ssl验证错误。这可以通过存在环境变量进行配置

GettyImagesApi_IgnoreSSLValidation
GettyImagesApi_UseProxy

*nix Shell示例

export GettyImagesApi_IgnoreSSLValidation=TRUE
export GettyImagesApi_UseProxy=127.0.0.0:8888

Windows CMD示例

set GettyImagesApi_IgnoreSSLValidation=TRUE
set GettyImagesApi_UseProxy=127.0.0.0:8888

PowerShell 示例

$env:GettyImagesApi_IgnoreSSLValidation=TRUE
$env:GettyImagesApi_UseProxy="127.0.0.0:8888"

测试

运行单元测试

测试项目包含使用PHPUnit 框架编写的单元测试。

执行单元测试

假设

  • 您已安装 PHPUnit

要执行所有单元测试:./vendor/bin/phpunit --bootstrap vendor/autoload.php unitTests/。

要执行一个测试类:./vendor/bin/phpunit --bootstrap vendor/autoload.php unitTests/EXAMPLETEST

维护者

要将新版本发布到Packagist,创建一个带有更新标签的新版本。webhook 将通知 Packagist 捕获最新版本。