API key

From Halo: Reach API Wiki
Jump to: navigation, search

To access the Halo: Reach stats API, you will need an API key. This is both to track usage of the API and to prevent unauthorized and unwanted use of the API (such as abuse of the API). If you are not a developer but still interested in the API, check out the brief API FAQ. If you have questions regarding the API, join the Reach Stats API group on Bungie.net and post your question in the forum.

Contents

[edit] How to get a key

To obtain a key, there are three steps you must follow:

  1. You must be a registered user on Bungie.net.
  2. You must agree to the Terms and Conditions for use of the API.
  3. Generate your unique API key. Sign in to your registered account on Bungie.net and visit http://www.bungie.net/Account/reachapikey.aspx. Click on the "Generate a New Key" button to generate your unique API key.

Once a key is generated, it is active and connected to your Bungie.net account. If you choose to generate another key, your previous key will be invalidated.



[edit] What's Next?

Now that you have your API key, get started with the API!

[edit] How to use your key

Every call to the API requires the key as a parameter. If the key is invalid or not present you will receive an error.

[edit] Example

http://www.bungie.net/api/reach/reachapijson.svc/game/metadata/{API KEY}
  • Where "{API KEY}" represents your API key as a parameter

[edit] How NOT to use your key

Do NOT ask for or use another developer's key. Additionally, you are NOT authorized to ask or require users of your application to enter their own key.

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox