devkind/writesonic-php

v1.1 2022-11-12 12:33 UTC

This package is auto-updated.

Last update: 2024-09-12 16:37:11 UTC


README

Latest Version on Packagist Total Downloads GitHub Actions

WritesonicPhp 是 Writesonic API 的简单 SDK 实现。它帮助以面向对象的方式访问 API。

获取 API 密钥

请注册账号并在 Writesonic 上申请 API 密钥。
请查看教程部分以获取更多信息

安装

您可以通过 composer 安装此包

composer require devkind/writesonic-php

用法

初始化

use Devkind\WritesonicPhp;

/** @var \Devkind\WritesonicPhp */
$writesonic  =  new WritesonicPhp(API_KEY);

或者我们可以静态初始化

/** @var \Devkind\WritesonicPhp */
$writesonic  =  \Devkind\WritesonicPhp::make(API_KEY);

端点

端点基本上是 Writesonic 支持的内容类型。

每个端点都需要一个 $engine$language 参数来从 Writesonic 进行查询。

    /** @var string $language */
    protected $language = 'en';

    /** @var string $engine */
    protected $engine = 'economy';

它支持以下引擎

economy, business

它支持以下语言

en, nl, fr, de, it, pl, es, pt-pt, pt-br, ru, ja, zh, bg, cs, da, el, hu, lt, lv, ro, sk, sl, sv, fi, et

为了更改语言或引擎,我们可以调用所有端点上的设置方法。

设置语言

/** @var \Devkind\WritesonicPhp\Endpoints\GenerateImage */
$endpoint = $writesonic->GenerateImage->setLanguage('br');

设置引擎

/** @var \Devkind\WritesonicPhp\Endpoints\GenerateImage */
$endpoint = $writesonic->GenerateImage->setEngine('business');

或者

/** @var \Devkind\WritesonicPhp\Endpoints\GenerateImage */
$endpoint = $writesonic->GenerateImage->setEngine('br')->setLanguage('br');

支持的对象/端点和用法详情

所有端点可以通过三种不同的方式调用

作为有效载荷

$object  =  new WritesonicPhp('test123');
/** @var \Devkind\WritesonicPhp\Endpoints\GoogleAds */
$endpoint = $object->GoogleAds;

$array = $endpoint->setPayload([
    "product_name" => 'test',
    "product_description" => 'test',
    "search_term" => 'test',
])->get();

通过设置方法

$object  =  new WritesonicPhp('test123');
/** @var \Devkind\WritesonicPhp\Endpoints\GoogleAds */
$endpoint = $object->GoogleAds;
/** @var array */
$array = $endpoint->setProductName('test')
    ->setProductDescription('test')
    ->setSearchTerm('test')
    ->get();

通过 generate 方法

/** @var \Devkind\WritesonicPhp\Endpoints\GoogleAds */
$endpoint = $writesonic->GoogleAds;
/** @var array */
$endpoint->generate(
	$product_name,
	$product_description,
	$search_term
);

通过 get 方法

/** @var array */
$endpoint = $writesonic->GoogleAds->get([
    "product_name" => 'test',
    "product_description" => 'test',
    "search_term" => 'test',
]);
点击此处 查看支持端点的完整文档

测试

composer test

变更日志

请参阅 CHANGELOG 了解最近有哪些变化。

贡献

请参阅 CONTRIBUTING 以获取详细信息。

安全

如果您发现任何安全相关的问题,请通过电子邮件 backend@devkind.com.au 而不是使用问题跟踪器。

致谢

许可

MIT 许可证 (MIT)。请参阅 许可文件 以获取更多信息。