Getting Started

Step 1: Sign Up

To browse the SISS REST API's and their documentation, you need to:

  • Sign up for an account

  • Wait for the activation email from us, it should be nearly instantaneous.

  • Click the email link to complete the process.

If you don't receive an email, please check your spam or junk email folder 

Once you have completed the registration flow, Sign in to the portal and browse the documentation for the SISS REST API's

Step 2: Obtain your Credentials

To build against the SISS REST API's, or to make calls via a tool like Postman, you need an Ocp-Apim-Subscription-Key, a Client ID and a Client Secret.

Your Ocp-Apim-Subscription-Key is obtained by Subscribing to a Product.   

  • The Ocp-Apim-Subscription-Key is a used to identify you to the API for the subscription you have chosen.

Your Client ID and Client Secret will be provided by SISS once we see that you have subscribed to a product. These will generally provided within 24 hours. If you have not been contacted by SISS within 2 working days, please send an email to sales@sissdata.com.au or api@siss.com.au.

  • The Client ID and Client Secret are required for generating your Authorisation to use the API, and are essential to protecting yourself and your customers.

Keep both of these pieces of information in a very safe place.

Subscribing to a Product

  • Go to the Products Page.

  • Select the product you wish to subscribe to.

    • Sandbox Products (can only be used against the SISS REST API Sandbox)

      • 429 Test - 1 call/minute - used for Testing 429 handling.

      • Sandbox - 200 calls/minute up to a maximum of 10,000 calls/day.

    • Production Products (can only be used once you have been approved for access to Production)

      • Tier 1 - 5 calls/second up to a maximum of 1,250,000 calls a month.

      • Tier 2 - 10 calls/second up to a maximum of 4,000,000 calls a month.

      • Tier 3 - 20 calls/second up to a maximum of 10,000,000 calls a month.

      • Unlimited - There are no throttling restrictions on calls to the API.

  • Confirm the details. You can provide your own name for the subscription.

Picture

  • Creating this product subscription will spur our team into action.  We will approve your subscription, and securely provide you with your Client ID and Client Secret.  If you have not been contacted by SISS within 2 working days, please send an email to sales@sissdata.com.au or api@siss.com.au.

Step 3: Try the API

SISS recommends using Postman to understand how the API works. 

Experiment with the API using one of the following:

Step 4: Optimise your usage

Check out our Tips, Tricks and Best Practices to get the best out of the SISS REST API's