Getting Started

Sign up for Developer Account

Sign up for a API developer account.

  • Create an account local to our API portal

This will allow you to log into this Portal and follow the next set of steps.

What is a Product?

Products are groupings of API's for developers to subscribe to for access for usage.

Subscribing to a Product

In order to subscribe to a Product:

  1. Click the "Products" link in the navigation bar.
  2. Click on the name of the Product you wish to subscribe to.
    • Hackathon - These are our standard set of publicly facing APIs for use during a hackathon.
  3. Click the "Subscribe" button.
  4. Enter a subscription name, if you wish.
  5. Click the "Confirm" button.

You can now test out API operations in the portal or get your subscription key and begin writing code to call the APIs.

Getting your Subscription Key

To find your subscription key:

  1. Click on the drop down menu next to your name in the navigation bar.
  2. Click "Profile."
  3. Under "Your subscriptions" click "Show" next to your primary or secondary key to display the value.

Your subscription key must be included as a header value when calling any of the APIs. You can find the name of the subscription key header by navigating to any of the API's operations. It will be listed under the "Request headers" section.

Viewing an Operation's Response Schema

In order to view the schema for a response from a given operation, you must click the "Schema" link under the response format tab (e.g. application/json).