raidkeeper/battlenet-api

Raidkeeper Battlenet API interface

v0.0.3 2022-11-28 21:38 UTC

This package is auto-updated.

Last update: 2024-04-29 00:27:04 UTC


README

Build Status Code Climate coverage Code Climate maintainability

This is an API client for Blizzard's World of Warcraft game, primarily used by Raidkeeper but available for use with any application.

Installation

You should install this using composer:

composer require raidkeeper/battlenet-api

Usage

// You will need a Battlnet ClientID and ClientSecret from https://api.battlenet.com
$clientId     = 'foobar';
$clientSecret = 'fizzbuzz';
$region       = 'us';

// The Battlenet client grants access to the API
$client = new Raidkeeper\Api\Battlenet\Client($region, $clientId, $clientSecret);

// Create a new Character object to interact with the 
$character = $client->loadCharacter('charname', 'sargeras');

// Once you have the Character object, you can start reaching out to API endpoints
$data  = $character->getProfile();
$data2 = $character->getEquipment();

License

This library is published under the MIT License