Getting Started

In this article you will learn how the Partner API gateway structures the various APIs we publish into products and how a developer can get access to them and use them.

Products

We publish several APIs for partners to access information regarding our brands, restaurants and menus. These individual APIs are published into one or more Products. Developers are granted access to the product and therefore all the APIs within the product.

Products simply group APIs that are designed to work together and allow a single subscription key to be used across all the APIs within the product.

For example, a menu is linked to a brand and a list of restaurants. To use the menu data effectively, a developer may need access to more information about the brand or the restaurants.  To ensure the developer can do this effectively, we have published the Menu API, the Brand API and the Restaurant API into the Menu Product.

APIs

Each API is provided with Open API specifications that can be downloaded to ease development workflows.  These specifications are also visible within the developer portal.  The parameters and response objects for each API endpoint and operation have been documented. 

The operations available to try within the portal.  Simply click the Try It button to execute the call from within the portal to view live data.

Furthermore, each API has a support page on this portal that provides additional information that is difficult to convey in the Open API specification.

Access to Products and APIs

The products and APIs that a developer account gets access to is controlled by Spur Corporation and is determined by the nature of the work the partner is contracted to carry out for us.

If you need access to a product or API, please request it via your contact at Spur Corporation and we will be in touch.

Developer Accounts

Developers that wish to use our APIs are required to sign up for an account.  Once the account is activated, access to the appropriate product will be assigned.  This can only be done by Spur Corporation and is not available via the API gateway at this time.

When the developer account has been assigned to a product, you will see the Products and APIs listed within this portal.

Subscription Keys

Each product requires a subscription key to call the APIs published into the product.  Subscriptions may be created on the product page for the specific product.  Follow the steps below to create a subscription.

1. Navigate to the Products page

2. Select the product you wish to create a subscription for.

3. In the Your subscriptions section, enter a product subscription name in the textbox.

4. Check the checkbox next to the terms.

5. Click the subscribe button.

You can create as many subscriptions as you need.  The general rule is to create a subscription for each use case you have for an API or product.  For example, don't use the same subscription for a mobile app for Spur and a website for RocoMamas.  Rather create a new subscription for each so that if the subscription keys need to be regenerated, you don't need to change the keys in multiple places.

Once the subscription has been created, the keys are available in your profile.