fabrn/ygoprodeck-client

适用于YgoProDeck API的现代PHP客户端

1.0.0 2023-12-21 14:55 UTC

This package is auto-updated.

Last update: 2024-09-21 16:36:02 UTC


README

使用PHP 8.1和cURL的现代PHP客户端,用于YgoProDeck API

使用Composer进行安装

composer require fabrn/ygoprodeckclient

使用客户端

客户端的主要入口点是YgoProDeckClient\Client类。从此点出发,您可以使用public properties访问特定资源的客户端。

$client = new Client();

$response = $client->cards->getAll();

如果您为Client实例未提供任何参数,则使用默认参数,默认参数为:

  • 语言:en
  • 版本:v7(请注意,此客户端是为v7设计的)

要自行配置客户端,只需将配置数组传递给Client实例即可。

$client = new Client([
    Client::PARAM_LANGUAGE => Language::French->value /* fr */,
    Client::PARAM_API_VERSION => 'v7'
]);

可以通过YgoProDeckClient\Enum\Language枚举访问每个可用的语言。这些语言包括:

  • 法语
  • 葡萄牙语
  • 德语
  • 意大利语

请注意,卡片图像将保持为英语。

资源客户端

速率限制

此API将速率限制设置为每1秒20个请求。此客户端目前不支持速率限制。请确保不要超过此速率限制,否则您的IP可能会被列入黑名单。

关于卡片图像的重要说明

如您通过API所见,卡片图像是通过URL "https://images.ygoprodeck.com/images/"提供的。如文档所述,请将图像存储在您自己的服务器上,以免给他们的网站造成过大压力。否则,您的IP也可能被列入黑名单。

许可证和法律声明

此软件包可在MIT许可证下使用。

请注意,YgoProDeckClient未经Konami或YgoProDeck的认可,也不反映他们的观点或意见。通过此客户端提供的所有信息,包括卡片图像、属性、等级/排名和类型符号以及卡片文本,均受Konami Digital Entertainment Inc.子公司4K Media Inc.的版权保护。