Home

Kadala Documentation Release 0.1.0 Finlay Beaton

1. 1 2 Creating a Client 5 Kadala Documentation Release 0 1 0 use Kadala Client use Kadala Region create a Client SapiKey my bnet api key Sclient new Client apiKey Region EUROPE fr FR 1 3 Get Artisan You can retrieve general information about an artisan what recipes could be learned and trained This is a good way to obtain the names and descriptions for a specific locale To learn what level a player s artisan is see Get Career instead There is currently no way to know what recipes that drop rare set and legendary the player has learned on their artisans 1 3 1 Methods Available methods on Client to get artisan data are getBlacksmith getJeweler getMystic e getArtisan lt artisan gt There are also constants on the Artisan object to provide to getArtisan BLACKSMITH JEWELER MYSTIC Sartisans array list of all of the above Special Case The mystic as of May 2015 does not have any trainable recipes You cannot guarantee this will always be the case and if want to make your code robust it is recommend you handle the future addition of recipes like any other artisan Certainly the API treats her as such Until then the tiers item in the ArtisanData structure will always be empty 1 3 2 Code Examples Blacksmith use Kadala Client use Kadala Region create a new Client Sapikey my bnet api key Sclient new Client Sapi
2. randomAffixes gems gt in getHero socketEffects gt SocketEffectData another SocketEffectData socketEffects recipe gt RecipeData craftedBy gt RecipeData another RecipeData craftedBy seasonRequiredToDrop gt int isSeasonREquiredtoDrop bool blockChance MinMaxData AttributeListData primary gt AttributeData another AttributeData primary secondary gt AttributeData another AttributeData secondary passive gt AttributeData another AttributeData passive AttributeData text gt string le color gt string affixType gt string AttributesRawListData string MinMaxData another string MinMaxData pair 14 Chapter 1 User manual Kadala Documentation Release 0 1 0 SocketEffectData attributes gt AttributeListData itemTypeName gt string lc itemTypeId string attributesRaw gt AttributesRawListData RecipeData id gt string slug string name gt string lc Cost int in gold reagents gt quantity gt int item gt ReagentItemData reagent another reagent reagents itemProduced ProducedItemData ReagentltemData id gt string name gt string lc icon gt string displayColor gt string tooltipParams gt string Produc
3. displayColor gt string LooltipParams string ProduceditemData Because two of ProducedItemData properties refer back up to RecipeData the 2nd time the ProducedItemData is listed the recipe and craftedBy properties are omitted to avoid an invite loop id gt string name gt string lc icon gt string displayColor gt string tooltipParams gt string recipe gt RecipeData 2nd pass omitted craftedBy gt RecipeData 2nd pass omitted RecipeData for Mystic without RecipeData The mystic as of May 2015 does not have any trainable recipes It is recommended you deal with the mystic like you would any other artisan However it is worth highlighting how simpler her data structure is as a result slug gt mystic name gt Mystic le portrait gt pt mystic training gt tiers gt empty for now training 1 4 Get Follower You can retrieve general information about a follower including a list of their possible skills This is a good way to obtain the names and descriptions for a specific locale To learn what specific follower skills and equipment a player uses see Get Hero instead 1 4 Get Follower 9 Kadala Documentation Release 0 1 0 1 4 1 Methods Available methods on Client to get follower data are getEnchantress getScoundrel e getTemplar getFollower lt follower gt There are also c
4. gt float critChance gt float damageReduction gt float thorns gt float lifeSteal gt float lifePerKill gt float goldFind gt float magicFind gt float lifeOnHit gt float primaryResource gt int secondaryResource gt int lin ZF Stats kills gt elites int lie kilis progression gt string act gt ActProgressData another string act gt ActProgressData pair progression dead gt bool last updated gt int HeroActiveSkillData The description and simpleDescription are displayed to the user depending on the simple descriptions in game option skill gt slug gt string name gt string Ic icon gt string level gt int categorySlug gt string tooltipUrl gt string description gt string lc simpleDescription gt string lc 20 Chapter 1 User manual Kadala Documentation Release 0 1 0 skillCalcId gt string ly ZZ srl rune gt slug gt string type gt string name gt string lc level gt int description gt string Ic simpleDescription gt string lc tooltipParams gt string skillCalcId gt string order gt int rune HeroPassiveSkillData skill gt slug gt string name gt string lc icon gt string level gt int tooltipUrl gt string descriptio
5. gt int kills highestHardcoreLevel gt int timePlayed gt string class id gt float another string class id gt float pair timePlayed progression gt string act id gt bool another string act id gt bool pair progression fallenHeroes gt todo coming soon fallenHeroes string artisan id Season Hardcore gt ArtisanCareerData another string artisan id Season Hardcore gt ArtisanCareerData pair seasonalProfiles gt string season name gt SeasonalProfileData another string season name gt SeasonalProfileData pair seasonalProfiles HeroCareerData paragonLevel gt int seasonal bool name gt string id gt int level gt int hardcore gt bool last updated gt int gender gt int dead gt bool class gt string 1 6 Get Career 17 Kadala Documentation Release 0 1 0 ArtisanCareerData slug gt string level gt string stepCurrent gt int stepMax gt int SeasonalProfileData seasonId gt int paragonLevel gt int paragonLevelHardcore gt int kills gt monsters gt int elites gt int hardcoreMonsters gt int ly ZZ kills highestHardcoreLevel gt int timePlayed gt string class id gt float another string class id gt float pair timePlayed progression gt
6. in game option slug gt string name gt string Ic icon gt string level gt int tooltipUrl gt string description gt string lc simpleDescription gt string lc skillCalcId gt string 1 5 Get Item You can retrieve general information about an item including some base stats This is a good way to obtain the names and descriptions for a specific locale To learn what specific items a player uses see Get Hero instead 1 5 1 Methods Available methods on Client to get item data are e getItem itemId 1 5 2 Code Example Set itemId to the id attribute of an item to retrieve it use Kadala Client use Kadala Region create a new Client SapiKey my bnet api key Sclient new Client Sapikey Region US 12 Chapter 1 User manual Kadala Documentation Release 0 1 0 retrieve the item data SitemId P1 CruShield norm unique 02 data client getItem itemId Sdata now contains the item data structure 1 5 3 Data Structures For Your Reference In the event that Blizzard changes the data structures returned by the API Kadala will still work 100 The library does not do any post processing and returns the data to you using json decode only You will likely have to change your processing code however We have listed the Data Structures as we saw them returned by the API lt https dev battle net io docs gt _ i
7. Tracker 1 9 4 How do support you Hi I m Finlay Beaton ofbeaton This software is only made possible by donations of fellow users like you en couraging me to toil the midnight hours away and sweat into the code and documentation Everyone s time should be valuable please seriously consider donating Website Paypal Donate Button Paypal Email Money Form 1 9 Frequently Asked Questions 25 Kadala Documentation Release 0 1 0 1 9 5 How do get involved I m glad you asked People interested in getting involved in the development of the library should head to the Con tributing section of the manual 1 10 Examples The examples directory of the library contains stand alone programs you can run and inspect to learn how to use the library They are useful if you re looking for complete A Z examples 1 10 1 Basic Client In examples basic client is client php This program will retrieve all API endpoints and write each to a json file Run it using the command php client php my bnet api key 1 11 Contributing We re glad you are considering contributing to this project It takes a lot of work to keep the library up to date and any help is appreciated 1 11 1 Where to start Report a bug or feature improvement in our issue tracker Submit an improvement to the documentation Pick an issue and send us a pull request with code to fix it If you decide to contribute code please ensure that you add the appr
8. client gt getFollower follower Sdata now contains the follower data structure do some processing on the data 1 4 3 Data Structures For Your Reference In the event that Blizzard changes the data structures returned by the API Kadala will still work 100 The library does not do any post processing and returns the data to you using json_decode only You will likely have to change your processing code however We have listed the Data Structures as we saw them returned by the API lt https dev battle net io docs gt _ in May 2015 for your convenience only The data you get back is organized in very specific ways using associative arrays Localized strings are marked with 1c Array items that may repeat are marked with Complex array items are sometimes split into their own Data Structure which may also repeat where marked FollowerData As of May 2015 the value of realName contains something like d3 follower templar realName which may be a bug 1 4 Get Follower 11 Kadala Documentation Release 0 1 0 slug gt string name gt string Ic realName gt string portrait gt string skills gt active gt FollowerActiveSkillData another FollowerActiveSkillData active passive gt not currently used skills FollowerActiveSkillData The description and simpleDescription are displayed to the user depending on the simple descriptions
9. structure 1 6 3 Data Structures For Your Reference In the event that Blizzard changes the data structures returned by the API Kadala will still work 100 The library does not do any post processing and returns the data to you using json decode only You will likely have to change your processing code however We have listed the Data Structures as we saw them returned by the API lt https dev battle net io docs gt _ in May 2015 for your convenience only The data you get back is organized in very specific ways using associative arrays Localized strings are marked with 1c Array items that may repeat are marked with Complex array items are sometimes split into their own Data Structure which may also repeat where marked 16 Chapter 1 User manual Kadala Documentation Release 0 1 0 CareerData The battleTag returned will not always be the same as the one requested There are many situations where a player battleTag changes however requesting their old battleTag retrieves their new profile with the new battleTag listed instead battleTag gt string paragonLevel gt int paragonLevelHardcore gt int paragonLevelSeason gt int paragonLevelSeasonHardcore gt int heroes gt HeroCareerData another HeroCareerData heroes lastHeroPlayed gt int lastUpdated gt int kills gt monsters gt int elites gt int hardcoreMonsters
10. Kadala Documentation Release 0 1 0 Finlay Beaton May 04 2015 Contents 1 User manual 3 d OVERVIOW 4 4 aid ee eee E S dore A as ee ee RSS 3 1 2 Creating a Client uxore sE X Re ee Eos HAR Oe A Re eR RUE EHE NURSE Eus 5 3 IGELAMISIM eS 2d A AAA mese thee ee ed rs 6 KA Get Follower 5 54 oes cat Ac eae at a pA Un Gk ee E ee d Oe 9 O GEES 40 xol eo de eb bea tebe bee ee MU E eee heed be Pea UR 12 LO Get Career s vna og a A a a Rr RR en ce Fe pce I dha te eae Ow a 16 I JGGtHero 4 voe ene ue x RR x eat eed hw oe FR Y 18 1 8 Setup Cachin 20s pos Good eke a robe TR Ra BR ADIRI ADU ds a 23 19 Frequently Asked Qu stoBS e don eso xor RUE mE Re Rho xo ue d RE ERROR S 25 110 Examples qns 2 9 reor dr SERE Sb metet e RW Sp t dte uos ers 26 LUT sContibutin s x kes eRe SERA RA FOX ECE E US 26 Kadala Documentation Release 0 1 0 Greetings Nephalem Kadala is a PHP 5 4 library that allows you to easily communicate with the Battle net Diablo 3 Web API This library provides a simple PHP class based interface with methods representing API data and makes use of features such as compression and caching to optimize your requests Contents 1 Kadala Documentation Release 0 1 0 2 Contents CHAPTER 1 User manual 1 1 Overview 1 1 1 Requirements PHP The Kadala library is tested on the following versions of PHP PHP 5 4 PHP 5 5 PHP 5 6 PHP 7 0 HHVM It additionally req
11. cache new Pool driver client setCache cache retrieve the item data SitemId P1 CruShield norm unique 02 data client gt getItem SitemId Sdata now contains the item type information 24 Chapter 1 User manual Kadala Documentation Release 0 1 0 1 9 Frequently Asked Questions 1 9 1 Questions Contents Frequently Asked Questions Questions How do I turn off compression How do I report an issue How do I support you How do I get involved 1 9 2 How do I turn off compression By default all communication from Battle net to the library is compressed Data is always returned to you fromt he library in an uncompressed state In vary rare circumstances it can be useful to turn off compressing responses If you choose to do this you may see significant slowdowns of especially larger responses The setSendCompressed method allows you to turn off compression use Kadala Client use Kalada Region create a new Client Sapikey my bnet api key Sclient new Client Sapikey Region US turn off compression Sclient gt setSendCompressed false all method calls including getItem will communicate with bnet uncompressed SitemId P1 CruShield norm unique 02 data client getItem itemId data now contains the item type information 1 9 3 How do report an issue Bug reports and feature requests can be submitted using the Github Issue
12. doubt pick your own use Kadala Client use Kadala Region create a Client SapiKey my bnet api key Sclient new Client Sapikey Region US You could then call methods on client to look up player data in Region US Create additional Client to access data from different regions at the same time 1 2 2 Choosing a Locale It is important to note that Item and player information is provided very differently for each locale A locale is a language as spoken in a specific country The information is different even in the case of the same language spoken in two different countries Battle net only supports specific locales for each _region_ The list of locales by region is e Region CHINA zh_CN China s Chinese e Region EUROPE en_GB Great Britain s English es ES Spain s Spanish r FR France s French ru RU Russia s Russian de DE Germany s German pt PT Portugal s Portuguese it IT Italy s Italian e Region KOREA ko KR South Korean s Korean e Region TAIWAN zh_TW Taiwan s Chinese e Region US en_US United State s English es MX Mexico s Spanish pt_BR Brazil s Por tugese If you do not specify a locale when creating your Client as above then the first one in this list for the region will be chosen as a default Here is an example of creating a Client specifying the Europe region and France French locale
13. editemData Unlike in artisan data recipe and craftedBy are never listed on this structure id gt string name gt string lc icon gt string displayColor gt string tooltipParams gt string MinMaxData min gt float 1 5 Get Item 15 Kadala Documentation Release 0 1 0 max gt float 1 6 Get Career You can retrieve information about a player called a career This includes paragon information the list and some information about their heroes and their global account progression To learn what specific items and skills a player uses on a hero see Get Hero instead There is currently no way to know what recipes that drop rare set and legendary the player has learned on their artisans Remember that player and hero data is specific to each region You must specify the correct region for the player you wish to retrieve or you will not get the data 1 6 1 Methods Available methods on C1ient to get player career data are getCareer lt battleTag gt 1 6 2 Code Example Notice how since wudijo 2228 plays in europe we had to specify Region EUROPE to our Client use Kadala Client use Kadala Region create a new Client SapiKey my bnet api key Sclient new Client Sapikey Region EUROPE retrieve the item data SbattleTag wudijo 2228 data client gt getCareer battleTag Sdata now contains the item data
14. et started quickly simpler caches including Filesystem and SQLite All cashing is done through the caching library called Stash 1 8 1 Filesystem cache Setting the location of the Filesystem cache is optional Notice the additional use statements 1 8 Set up Caching 23 Kadala Documentation Release 0 1 0 use Stash Driver Filesystem use Stash Pool use Kadala Client use Kadala Region create a new Client SapiKey my bnet api key Sclient new Client Sapikey Region US create the driver for our cache Sdriver new FileSystem optionally set a custom location for the cache Sdriver gt setOptions path gt tmp myCache 1 create and set the cache Scache new Pool driver client setCache cache retrieve the item data SitemId P1 CruShield norm unique 02 data client getItem itemId data now contains the item type information 1 8 2 SQLite cache Setting the location of the SOLite cache is optional Notice the additional use statements use Stash Driver Sqlite use Stash Pool use Kadala Client use Kadala Region create a new Client SapiKey my bnet api key Sclient new Client Sapikey Region US create the driver for our cache Sdriver new Sqlite optionally set a custom location for the cache Sdriver gt setOptions path gt tmp myCache l create and set the cache S
15. hp at the very top before everything xcept namespaces and use statements require vendor autoload php 1 1 3 Quickstart Item retrieval To obtain the P1 CruShield norm unique 02 item type from the US battle net use Kadala Client use Kadala Region create a new Client Sapikey my bnet api key Sclient new Client Sapikey Region US retrieve the item data SitemId P1 CruShield norm unique 02 data client getItem S itemId Sdata now contains the item type information Player Career retrieval List of characters and career information for the european player battle tag wudijo 2228 use Kadala Client use Kadala Region create a new client Sapikey my bnet api key region must match where the player plays Sclient new Client Sapikey Region EUROPE retrieve the career data SbattleTag wudijot2228 4 Chapter 1 User manual Kadala Documentation Release 0 1 0 data client gt getCareer battleTag Sdata now contains the career information 1 2 Creating a Client 1 2 1 Selecting a Region Player Career and Hero data is specific to a region so it is important to connect to the right one Here is the list of all valid regions for Diablo 3 Region CHINA A e Region EUROP e Region KOREA Region TAIWAN e Region US You will need a Client for each region you want to access when in
16. is organized in very specific ways using associative arrays Localized strings are marked with 1c Array items that may repeat are marked with Complex array items are sometimes split into their own Data Structure which may also repeat where marked HeroData id gt int heroId name gt string class gt string gender gt int level gt int paragonLevel int hardcore bool seasonal bool seasonCreated int Skills gt active gt HeroActiveSkillData another HeroActiveSkillData active passive gt HeroPassiveSkillData another HeroPassiveSkillData LC Skills items gt string slot gt HeroltemData another string slot gt HeroltemData items followers gt HeroFollowerData another HeroFollowerData l stats gt life gt int 1 7 Get Hero 19 Kadala Documentation Release 0 1 0 damage gt float toughness gt float healing gt float attackSpeed gt float armor gt int strength gt int dexterity gt int vitality gt int intelligence gt int physicalResist gt int fireResist gt int coldResist gt int lightningResist gt int poisonResist gt int arcaneResist gt int critDamage gt float blockChance gt float blockAmountMin gt int blockAmountMax gt int damageIncrease
17. key Region US retrieve the blacksmith data 6 Chapter 1 User manual Kadala Documentation Release 0 1 0 data client gt getBacksmith Sdata now contains the artisan data structure Jeweler use Kadala Client use Kadala Region create a new Client SapiKey my bnet api key Sclient new Client Sapikey Region US retrieve the jeweler data data client gt getJeweler Sdata now contains the artisan data structure Mystic use Kadala Client use Kadala Region create a new Client SapiKey my bnet api key Sclient new Client Sapikey Region US retrieve the mystic data data client gt getMystic Sdata now contains the artisan data structure All You could use the getArt isan method to retrieve them all in quick succession use Kadala Client use Kadala Region use Kadala Artisan create a new Client SapiKey my bnet api key Sclient new Client SapiKey Region US loop through each available artisan foreach Artisan Sartisans as Sartisan data Sclient gt getArtisan Sartisan Sdata now contains the artisan data structure do some processing on the data 1 3 Get Artisan 7 Kadala Documentation Release 0 1 0 1 3 3 Data Structures For Your Reference In the event that Blizzard changes the data structures returned by the API Kadala will still work 100 The library does n
18. n gt string lc flavor gt string lc skillCalcId gt string AF Skill HeroltemData Depending on the type of item requested some fields may not be present For example recipe is only returned when the item can be crafted When the transmogItem property refers to a new HeroItemData transmogItem property is omitted on the item it points to This is a special toolt ipParams field that contains a string you can use to lookup the particular item attributes sockets gems etc It is different than the general tooltipParam you usually get including the one from get Item id gt string name gt string icon gt string displayColor gt string tooltipParams gt string recipe gt RecipeData transmogltem gt HeroltemData craftedBy gt RecipeData IZ another RecipeData 1c omitted on l transmogitem HeroltemData 1 7 Get Hero 21 Kadala Documentation Release 0 1 0 HeroFollowerData slug gt string level gt int items gt string slot HeroItemData another string slot HeroltemData pair items stats gt goldFind gt int magicFind gt int experienceBonus gt int stats Skills gt FollowerActiveSkillData another FollowerActiveSkillData skills FollowerActiveSkillData The description and simpleDescription are displayed to the user depending on the simple descrip
19. n May 2015 for your convenience only The data you get back is organized in very specific ways using associative arrays Localized strings are marked with 1c Array items that may repeat are marked with Complex array items are sometimes split into their own Data Structure which may also repeat where marked ItemData Depending on the type of item requested some fields may not be present For example recipe is only returned when the item can be crafted Additionally some fields only hold data when this structure appears in get Hero id gt string name gt string lc icon gt string displayColor gt string tooltipParams gt string requiredLevel gt int itemLevel gt int bonusAffixes gt int bonusAffixesMax gt int accountBound gt bool flavorText gt string Ic typeName gt string lc type gt twoHanded gt bool id gt string type dps gt MinMaxData attacksPerSecond MinMaxData minDamage MinMaxData maxDamage gt MinMaxData armor gt MinMaxData slots gt string another string slot name slots attributes gt AttributeListData attributesRaw AttributesRawListData randomAffixes gt 1 5 Get Item 13 Kadala Documentation Release 0 1 0 oneOf gt attributes gt AttributeListData attributesRaw gt AttributesRawListData oneOf
20. onstants on the Follower object to provide to getFollower ENCHANTRESS SCOUNDREL TEMPLAR e Sfollowers array list of all of the above 1 4 2 Code Examples Enchantress use Kadala Client use Kadala Region create a new Client Sapikey my bnet api key Sclient new Client Sapikey Region US vetrieve the enchantress data data client gt getEnchantress Sdata now contains the follower data structure Scoundrel use Kadala Client use Kadala Region create a new Client SapiKey my bnet api key Sclient new Client Sapikey Region US retrieve the scoundrel data data client gt getScoundrel Sdata now contains the follower data structure Templar 10 Chapter 1 User manual Kadala Documentation Release 0 1 0 use Kadala Client use Kadala Region create a new Client SapiKey my bnet api key Sclient new Client Sapikey Region US retrieve the templar data data client gt getTemplar Sdata now contains the templar data structure All You could use the get Follower method to retrieve them all in quick succession use Kadala Client use Kadala Region use Kadala Follower create a new Client SapiKey my bnet api key Sclient new Client Sapikey Region US loop through each available follower foreach Follower Sfollowers as Sfollower data
21. opriate unit tests that covers your change The project must also build properly 1 11 2 Building the project php composer phar install bin phing dist bin phing all If you are fixing an issue you MUST submit an accompanying unit test that fails in the current version but passes with your fix Code quality is important and things that must run without errors e phpfcb must successfully beautify your code e phpcs must report Zero Code Style errors or warnings See build browser index html phpunit unit tests must run with Zero errors humbug mutation testing must pass with Zero errors build coverage index html must report 10046 code coverage 26 Chapter 1 User manual Kadala Documentation Release 0 1 0 apigen and apigen dev must successfully generate documentation Good luck in your adventures Nephalem 1 11 Contributing 27
22. ot do any post processing and returns the data to you using json decode only You will likely have to change your processing code however We have listed the Data Structures as we saw them returned by the API lt https dev battle net io docs gt _ in May 2015 for your convenience only The data you get back is organized in very specific ways using associative arrays Localized strings are marked with 1c Array items that may repeat are marked with Complex array items are sometimes split into their own Data Structure which may also repeat where marked ArtisanData slug string name gt string lc portrait gt string training gt tiers gt ter antsy levels gt tierLevel int percent int trainedRecipes gt RecipeData another RecipeData trainedRecipes upgradeCost gt int in gold upgradeltems gt level another level levels 1 du tier another tier tiers training RecipeData id gt string slug gt string name gt string lc cost gt int in gold reagents gt quantity gt int item gt ReagentItemData 8 Chapter 1 User manual Kadala Documentation Release 0 1 0 reagent another reagent reagents itemProduced ProducedItemData ReagentltemData id gt string name gt string lc icon gt string
23. string act id gt bool another string act id gt bool pair progression 1 7 Get Hero You can retrieve detailed information about a player hero including the skills and gear loadout for themselves and their followers For general player account information like their artisan progress call Get Career instead 1 7 1 Methods Available methods on Client to get _item_ data are e getHero lt battleTag gt lt herold gt 1 7 2 Code Example Notice how since wudijo 2228 plays in europe we had to specify Region EUROPE to our Client use Kadala Client use Kadala Region create a new Client SapiKey my bnet api key 18 Chapter 1 User manual Kadala Documentation Release 0 1 0 Sclient new Client Sapikey Region EUROPE retrieve the item data SbattleTag wudijo42228 SheroId 35436981 data S client getHero battleTag S heroId Sdata now contains the hero data structure 1 7 3 Data Structures For Your Reference In the event that Blizzard changes the data structures returned by the API Kadala will still work 100 The library does not do any post processing and returns the data to you using json_decode only You will likely have to change your processing code however We have listed the Data Structures as we saw them returned by the API lt https dev battle net io docs gt _ in May 2015 for your convenience only The data you get back
24. tions in game option slug gt string name gt string lc icon gt string level gt int tooltipUrl gt string description gt string lc simpleDescription gt string lc skillCalcId gt string ActProgressData completed gt bool completedQuests gt QuestData another QuestData 1 completedQuests QuestData slug gt string name gt string lc 22 Chapter 1 User manual Kadala Documentation Release 0 1 0 RecipeData id gt string slug gt string name gt string lc cost gt int in gold reagents gt quantity gt int item gt ReagentItemData reagent another reagent reagents itemProduced ProducedItemData ReagentltemData id gt string name gt string lc icon gt string displayColor gt string tooltipParams gt string ProducedltemData Unlike in artisan data recipe and craftedBy are never listed on this structure id gt string name gt string lc icon string displayColor gt string tooltipParams gt string 1 8 Set up Caching One way to speed up your requests to the API is to cache the responses That way when you ask for the resource again and it has not changed the library will return the cached copy You can use top of the line caching software like memcached or redis as well as g
25. uires the use of Composer for dependency management Dependencies If you use composer skip this section as it will automatically download the following additional required libraries for you Guzzle PHP HTTP Client e Stash PHP Caching Client Version Github version helpers Battle net API Key You will need an API key from the Battle net API Portal 1 Register for an account on the Battle net API Portal This will be different from your regular battle net ac count 2 Login on the Battle net API Portal This is different from logging into the main Battle net website or the Bat tle net desktop launcher 3 Create a new application on the My Applications page You will need to know where on the internet your website will function don t worry if your website is just an information page about your application Kadala Documentation Release 0 1 0 4 Obtain your key from the My Applications page You will not need the secret listed on other pages just your key This is your API key and should be used whenever you are asked for an apiKey or my bnet api key 1 1 2 Installing via Composer The recommended way to install Kadala is through Composer Install Composer curl sS https getcomposer org installer php Next run the Composer command to install the latest stable version composer phar require kadala kadala After installing you need to require Composer s autoloader in your code yourphpfile p

Kadala Documentation Release 0.1.0 Finlay Beaton

Contents

Download Pdf Manuals

Related Search

Related Contents