qbnk/templafy-apiwrapper

Templafy 的 API 封装器

0.2 2022-09-25 12:28 UTC

This package is auto-updated.

Last update: 2024-08-25 16:24:57 UTC


README

一个简单的 Templafy API 封装器 https://www.templafy.com 允许通过 PHP 与 Templafy 进行简单通信,设置简单。

似乎有 API 的两个版本可用,此 API 封装器使用 https://api-v1.templafy.com/swagger/ui/index#/。这个版本的 API 似乎更适合合作伙伴,允许直接通过 "channelId" 接口,而不需要知道该渠道属于哪个库。

要求

  • PHP 7.2+
  • Guzzle 6.1+

安装

composer require qbnk/templafy-apiwrapper ^0.1

授权

Templafy 的 API 使用 OAuth2 和客户端凭据流。这意味着您需要 客户端 ID客户端密钥 才能授权和使用 API。 客户端 ID 是 templafy 实例的子域。如果实例域是 customer.templafy.com,则 客户端 IDcustomer客户端密钥 可在 Templafy 管理中获取。

示例

要创建一个可以授权 API 的实例,只需将带有 客户端 ID客户端密钥Credentials 实例传递给 TemplafyApi 构造函数。然后库将处理其余部分。

$api = new TemplafyApi(new Credentials('customer', 'client secret'));

常见问题解答

如何创建绝对根目录下的文件夹?

您必须为所有要创建的文件夹传递一个 parentFolderId。当创建根文件夹时,此值是图像库本身的 ID。您可以在 Templafy 管理中查看图像库时在 URL 中找到此值。它是查询参数 categoryId