yogarine/bungie-sdk-php

这些端点构成了 Bungie.net 提供的功能,包括更传统的网站功能以及连接到 Bungie 视频游戏及其相关功能。

dev-master 2023-01-07 19:16 UTC

README

这些端点构成了 Bungie.net 提供的功能,包括更传统的网站功能以及连接到 Bungie 视频游戏及其相关功能。

此 PHP 包由 OpenAPI Generator 项目自动生成

要求

PHP 5.5 及以上版本

安装与使用

Composer

要通过 Composer 安装绑定,请在 composer.json 中添加以下内容

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/yogarine/bungie-sdk-php.git"
    }
  ],
  "require": {
    "yogarine/bungie-sdk-php": "*@dev"
  }
}

然后运行 composer install

手动安装

下载文件并包含 autoload.php

    require_once('/path/to/bungie-sdk-php/vendor/autoload.php');

测试

要运行单元测试

composer install
./vendor/bin/phpunit

入门

请遵循 安装过程,然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apiKey
$config = Bungie\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Bungie\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');

$apiInstance = new Bungie\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getAvailableLocales();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->getAvailableLocales: ', $e->getMessage(), PHP_EOL;
}

?>

API 端点文档

所有 URI 都相对于 https://www.bungie.net/Platform

模型文档

授权文档

apiKey

  • 类型: API密钥
  • API密钥参数名: X-API-Key
  • 位置: HTTP头部

oauth2

  • 类型: OAuth
  • 流程: accessCode
  • 授权URL: https://www.bungie.net/en/OAuth/Authorize
  • 作用域:
  • ReadBasicUserProfile: 读取基本用户资料信息,例如用户名、头像图标等。
  • ReadGroups: 读取用户已加入的群组/家族论坛、墙和成员。
  • WriteGroups: 为用户已加入的群组/家族论坛、墙和成员写入。
  • AdminGroups: 管理用户是创始人或管理员的群组/家族论坛、墙和成员。
  • BnetWrite: 创建新的群组、家族和论坛帖子,以及其他保留给Bungie.net高级作用域的操作:不建议第三方应用使用。
  • MoveEquipDestinyItems: 移动或装备《命运》物品。
  • ReadDestinyInventoryAndVault: 读取《命运1》库存和保险库内容。对于《命运2》,此作用域需要读取任何被视为私有的内容。这是《命运2》应用进行读取操作所需的最小作用域,例如库存、保险库、货币、商人、里程碑、进度等。
  • ReadUserData: 读取用户数据,例如他们的Web通知、家族/群组成员资格、最近活动、静音用户。
  • EditUserData: 编辑用户数据,例如首选语言、状态、座右铭、头像选择和主题。
  • ReadDestinyVendorsAndAdvisors: 访问特定于用户的商家和顾问数据。已废弃。此作用域仅在《命运1》API中使用。
  • ReadAndApplyTokens: 读取优惠历史记录并代表用户领取和申请代币。
  • AdvancedWriteActions: 可以执行会导致通过《命运》应用提示用户的行为。
  • PartnerOfferGrant: 可以使用合作伙伴优惠API领取为合作伙伴定义的奖励。
  • DestinyUnlockValueQuery: 允许应用查询通过常规方法不可用的敏感信息,如解锁标志和值。
  • UserPiiRead: 允许应用查询敏感用户PII,尤其是电子邮件信息。

作者

support@bungie.com