iceq1337/steam-inventory-api

用于从Steam库存中获取物品的PHP库

1.1.0 2024-02-14 14:53 UTC

This package is auto-updated.

Last update: 2024-09-14 16:29:32 UTC


README

Latest Stable Version Total Downloads PHP Version Require License

此库提供了一种简单的方法,通过PHP代码访问公共Steam库存API(https://steamcommunity.com/inventory/),并从中获取物品的信息。

使用此API不需要API密钥,但因为它不是Steam Web API的一部分,所以每天10万次请求的限制不适用。相反,此API的速率限制非常低。因此,请谨慎使用此API或库。

尽管使用此API通常不建议,但它已经存在于Steam中很长时间了,尽管或可能正因为2016年的重写,它可能还会继续存在。

此库设计得易于其他开发者扩展。它应该有良好的文档,并包括一个全面的测试套件。

需求

  • PHP >= 8.1

此库支持所有官方和积极支持的PHP版本。

查看composer.json了解其他需求。

安装

composer require iceq1337/php-steam-inventory

用法

use SteamInventory\Inventory;

$options = [
    'steamid' => '76561198129782984',
    'appid' => 753, // default: 753
    'contextid' => 6, // default: 6
    'language' => 'english', // default: 'english'
    'all_items' => false, // default: false
    'count' => 100, // default: 500, max: 5000
    'start_assetid' => null, // default: null, used for consecutive requests
];

$inventory = new Inventory($options);
$items = $inventory->getItems();
$total = $inventory->total_inventory_count;

foreach ($items as $item) {
    echo $item->getName() . "<br>";
}

贡献

目前没有贡献指南。为了向项目做出贡献,请遵循GitHub标准分支和拉取请求工作流程。

  • 在GitHub上此仓库。
  • 克隆项目到您的计算机。
  • 提交更改到您的分支。
  • 推送到您的分支。
  • 提交一个拉取请求,以便我可以审查您的更改

请确保在提交拉取请求之前始终运行测试并应用代码风格。只有当所有测试和代码风格工作流程都通过时,才能批准和合并拉取请求。

composer run test
composer run lint

许可

此库受MIT许可的许可。

鸣谢

此库的部分基于PHP Steam Inventory,由matthewlilley在2018年发布。