[b]What is an API?[/b]
An application-programming interface (API) is a set of programming instructions and standards for accessing a Web-based software application or Web tool. A software company releases its API to the public so that other software developers can design products that are powered by its service.
For example twitter has an API so developers can create apps that connect to twitter e.g. Echofon.
[b]What is an API Key?[/b]
The key gives a developer access to Reach's API, inturn giving the developer RAW data. With this key you can get data on Halo Reach players, matches etc. for any applications you are building. For example something like Halocharts has been using the Reach API for getting it's stats.
[b]Reach API Group[/b]
Back when the Beta was out Achronos made a group for this API and invited certain developers in the community access to the API and the group. It was called "Potato" and has had its name changed to "[url=http://www.bungie.net/fanclub/statsapi/Group/GroupHome.aspx]Reach Stats API[/url]". I'm a member and others like Firestream, dazarobbo, paulmarv etc. When the API goes live and gets the green light the group will be open to the public. Until then don't try joining you will be rejected.
[b]Will I need to use my Key?[/b]
Unless you are a developer, no.
To 99.9% of the user this is an irrelevant option.
[b]So when I do this, it allows the developers to gather data on me?[/b]
No the key is to get YOURSELF access to the API. Developers can always get your Halo: Reach data regardless. Though all they can access is your game stats nothing else. The API does not have anything to do with Bungie.net or any personal details.
[b]Do I need my key to use someone else's app?[/b]
No. The API key is only for the developer. Do not give anybody your key as its against the rules for someone to use another persons key. If an app asks for your key report it to Achronos or in the API group when it opens.
[b]Notes[/b]
[quote][b]Posted by:[/b] Achronos
Information on how to develop against the Halo: Reach stats API will be available at www.bungie.net/stats/reach/online.aspx after everything is turned on.
99% of you don't need to care about it.[/quote]
Feel free to ask questions here.
[Edited on 09.13.2010 12:46 PM PDT]
-
[quote][b]Posted by:[/b] FoxHoundNinja 8 [quote][b]Posted by:[/b] perfecsaiyan I'm hoping Bungie's staff will release some documentation or FAQs shortly.[/quote] Dido I just found out that I can make Android APPs for free. :)[/quote] They wont be releasing a documentation in great detail. But the founding community developers are writing a wiki for the API.
-
[quote][b]Posted by:[/b] perfecsaiyan I'm hoping Bungie's staff will release some documentation or FAQs shortly.[/quote] Dido I just found out that I can make Android APPs for free. :)
-
I'm also getting errors when making requests to the URL's in the [url=http://www.bungie.net/fanclub/statsapi/Group/Resources/Article.aspx?cid=545064]API Definition Article[/url] I'm interested in getting this thing started and writing some C# wrappers around the services for Win Phone 7.
-
Very interesting read.
-
I'm hoping Bungie's staff will release some documentation or FAQs shortly. I just got access to Google's App Inventor, am I'm looking into creating a stats APP for the Android OS...
-
I, too, was hoping for a release-day launch of the API, but when I try to make a request it gives me an error and tells me to refer to the server logs. I can't do that... I'm interested to see just what data can be gotten with this. Mostly I'm interested in the player model, emblem, rank, etc. for my site. I've got some other ideas and I'm in the planning / early writing stages for a program in C#, I just need the API turned on so I can start testing!
-
Really curious to know the ETA of when the API will be released. I was hoping for the day of Reach's launch. Any update?
-
[quote][b]Posted by:[/b] JABBERWOCK xeno [quote][b]Posted by:[/b] ApocalypeX OP updated. [quote][b]Posted by:[/b] JABBERWOCK xeno So, will there be a news story on the front page when this is open to the rest of us?[/quote] Well most likely no but in the API group it will. Though if you are not a developer this has no use to you nor should you spare it a thought.[/quote] Well, then how will we know when the group opens up? I am not a developer, but this kind of thing interests me, and it would be useful for various personal projects I am doing.[/quote] First you can wait till Reach is out. Then check the group front page. When the News Story saying "Do not join" isn't there then the group is open.
-
[quote][b]Posted by:[/b] ApocalypeX OP updated. [quote][b]Posted by:[/b] JABBERWOCK xeno So, will there be a news story on the front page when this is open to the rest of us?[/quote] Well most likely no but in the API group it will. Though if you are not a developer this has no use to you nor should you spare it a thought.[/quote] Well, then how will we know when the group opens up? I am not a developer, but this kind of thing interests me, and it would be useful for various personal projects I am doing.
-
OP updated. [quote][b]Posted by:[/b] JABBERWOCK xeno So, will there be a news story on the front page when this is open to the rest of us?[/quote] Well most likely no but in the API group it will. Though if you are not a developer this has no use to you nor should you spare it a thought.
-
So, will there be a news story on the front page when this is open to the rest of us?
-
Can you only access the stats with that API or other data like Player ID, PlayerModel, Joined Date and such things from the players stats website too? Never worked with SOAP yet and before i learn it i need some answers. ;) [Edited on 09.13.2010 10:36 AM PDT]
-
I personally think it was a bad move to put it in the "Game Setting" section. It will only lead to curiosity.
-
*ignore this post..* [Edited on 09.07.2010 8:21 PM PDT]
-
Well, thanks for the info Apoc.
-
[i]*Saves Thread...*[/i] This was very helpful. Of course, I highly doubt that I will even use the Reach API for anything at all, like Achronos said.
-
Nice! I better get that Objective C under my belt.
-
Cool, thanks!
-
yay go web developers!
-
[quote][b]Posted by:[/b] FoxHoundNinja 8 [quote][b]Posted by:[/b] ev1l tr1t0n [quote][b]Posted by:[/b] ApocalypeX [quote][b]Posted by:[/b] Screecherz [quote][b]Posted by:[/b] ev1l tr1t0n Hmm... only five?[/quote]What exactly happens when a request is completed? Can you only download the stats for 5 people per second? 5 games? 5 days? I'm sorry for not being the most technically inclined, but I do find this really pretty interesting.[/quote] A request is a requesting via connecting to the server for a bundle of data. A bundle of data could be a players service record, game history or a game etc. But this wont matter to the user, only the developer. [/quote] This. Just think of a request as loading a webpage, because that's basically what it is. Anyways, a limit of five is extremely low. Imagine HaloCharts, a website with over 100,000 registered users. When Reach comes out, a lot of people will be wanting to collect their stats. A limit of five simply wouldn't cut it for HaloCharts. However, I wouldn't be surprised if the allotted amount could be changed for different keys if the reason is legitimate (as in the case of HaloCharts and websites like it). [quote][b]Posted by:[/b] FoxHoundNinja 8 [quote][b]Posted by:[/b] ev1l tr1t0n Ah ok, thanks for clarifying. They can do stats like those because they essentially store a list of every person to play Halo 3, along with data such as their player model. All they have to do is write a query that counts the amount of players using each player model. Now, it would be possible to do something like that without having access to a list of all players, but it would take a really long time because you would have to go through every game of Halo 3 played to get a list of all people that have played Halo 3. After that, you would have to go to each player's service record and check their player image URL.[/quote] How detailed is it? could someone write something that counts how many people are using armour pieces like the recon helmet?[/quote] Detailed down to armor piece, color and size of display. Check it out: [url]http://www.bungie.net/Stats/Halo3/PlayerModel.ashx?p1=0&p2=9&p3=3&p4=3&p5=3&p6=0&p7=2&p8=2&p9=145[/url][/quote] Cool but say its 3 months after launch I have my armor setup and the know-how could I make something that tells me how many people are also wearing the same armor setup?[/quote] The only way to get a 100% correct number would be to query Bungie's database, and only Bungie employees can do that. Another option would be to create your own list of all distinct Reach players by going through every game of Reach played, and then checking armor URLs for each player in the list. However, this is problematic because it would take a really long time, which would lead to the dataset becoming outdated once you're done the entire process. If you don't care about precision and simply want an estimated percentage of other players with the same armor you could use a much smaller list of users instead. For example, websites like HaloCharts could provide data like this. In fact, it does. [url=http://halocharts.com/halo3.php?player=lncantation]Hover over my player image to see.[/url]
-
[quote][b]Posted by:[/b] ev1l tr1t0n [quote][b]Posted by:[/b] ApocalypeX [quote][b]Posted by:[/b] Screecherz [quote][b]Posted by:[/b] ev1l tr1t0n Hmm... only five?[/quote]What exactly happens when a request is completed? Can you only download the stats for 5 people per second? 5 games? 5 days? I'm sorry for not being the most technically inclined, but I do find this really pretty interesting.[/quote] A request is a requesting via connecting to the server for a bundle of data. A bundle of data could be a players service record, game history or a game etc. But this wont matter to the user, only the developer. [/quote] This. Just think of a request as loading a webpage, because that's basically what it is. Anyways, a limit of five is extremely low. Imagine HaloCharts, a website with over 100,000 registered users. When Reach comes out, a lot of people will be wanting to collect their stats. A limit of five simply wouldn't cut it for HaloCharts. However, I wouldn't be surprised if the allotted amount could be changed for different keys if the reason is legitimate (as in the case of HaloCharts and websites like it). [quote][b]Posted by:[/b] FoxHoundNinja 8 [quote][b]Posted by:[/b] ev1l tr1t0n Ah ok, thanks for clarifying. They can do stats like those because they essentially store a list of every person to play Halo 3, along with data such as their player model. All they have to do is write a query that counts the amount of players using each player model. Now, it would be possible to do something like that without having access to a list of all players, but it would take a really long time because you would have to go through every game of Halo 3 played to get a list of all people that have played Halo 3. After that, you would have to go to each player's service record and check their player image URL.[/quote] How detailed is it? could someone write something that counts how many people are using armour pieces like the recon helmet?[/quote] Detailed down to armor piece, color and size of display. Check it out: [url]http://www.bungie.net/Stats/Halo3/PlayerModel.ashx?p1=0&p2=9&p3=3&p4=3&p5=3&p6=0&p7=2&p8=2&p9=145[/url][/quote] Cool but say its 3 months after launch I have my armor setup and the know-how could I make something that tells me how many people are also wearing the same armor setup?
-
[quote][b]Posted by:[/b] Screecherz [quote][b]Posted by:[/b] ev1l tr1t0n Anyways, a limit of five is extremely low. Imagine HaloCharts, a website with over 100,000 registered users.[/quote]Couldn't it work by a user-request basis? I would be surprised if 5 users per second were looking to update their stats. So could it not work where a user requests a stats update and then that request gets queued? (and then use any remaining requests per second to do a broad stats update for all registered users)[/quote] Yes, requests could be put into a queue, but generally users don't like to wait.
-
Hmm. this might be off-topic but i would rather post here then start a new thread. Wasn't there a DMR nameplate? I remember seeing it on the BWU.
-
[quote][b]Posted by:[/b] ev1l tr1t0n Anyways, a limit of five is extremely low. Imagine HaloCharts, a website with over 100,000 registered users.[/quote]Couldn't it work by a user-request basis? I would be surprised if 5 users per second were looking to update their stats. So could it not work where a user requests a stats update and then that request gets queued? (and then use any remaining requests per second to do a broad stats update for all registered users)
-
[quote][b]Posted by:[/b] ApocalypeX [quote][b]Posted by:[/b] Screecherz [quote][b]Posted by:[/b] ev1l tr1t0n Hmm... only five?[/quote]What exactly happens when a request is completed? Can you only download the stats for 5 people per second? 5 games? 5 days? I'm sorry for not being the most technically inclined, but I do find this really pretty interesting.[/quote] A request is a requesting via connecting to the server for a bundle of data. A bundle of data could be a players service record, game history or a game etc. But this wont matter to the user, only the developer. [/quote] This. Just think of a request as loading a webpage, because that's basically what it is. Anyways, a limit of five is extremely low. Imagine HaloCharts, a website with over 100,000 registered users. When Reach comes out, a lot of people will be wanting to collect their stats. A limit of five simply wouldn't cut it for HaloCharts. However, I wouldn't be surprised if the allotted amount could be changed for different keys if the reason is legitimate (as in the case of HaloCharts and websites like it). [quote][b]Posted by:[/b] FoxHoundNinja 8 [quote][b]Posted by:[/b] ev1l tr1t0n Ah ok, thanks for clarifying. They can do stats like those because they essentially store a list of every person to play Halo 3, along with data such as their player model. All they have to do is write a query that counts the amount of players using each player model. Now, it would be possible to do something like that without having access to a list of all players, but it would take a really long time because you would have to go through every game of Halo 3 played to get a list of all people that have played Halo 3. After that, you would have to go to each player's service record and check their player image URL.[/quote] How detailed is it? could someone write something that counts how many people are using armour pieces like the recon helmet?[/quote] Detailed down to armor piece, color and size of display. Check it out: [url]http://www.bungie.net/Stats/Halo3/PlayerModel.ashx?p1=0&p2=9&p3=3&p4=3&p5=3&p6=0&p7=2&p8=2&p9=145[/url] [Edited on 09.07.2010 7:02 PM PDT]
-
[quote][b]Posted by:[/b] dazarobbo [quote][b]Posted by:[/b] BadCompany Brik Hmm, I suppose that's just another reason to start learning to program.[/quote]Oh I wouldn't worry [i]too[/i] much about that. *cheeky grin*[/quote]The only scenario I can see working in which I wouldn't have to worry about that is if you became my programming slave and made all the apps I could think of. Which seems a lot less realistic than me just learning to make them myself.