Skip to main content

Authenticating with our API

To use our API, you first need to obtain a subscription key. This key will be unique to each user of the API.

Once you have a valid subscription key, it should be passed to each request through the subscription-key HTTP header. The API key is required by all SimplyIOA APIs.

How to request a subscription key​

You must request a Sandbox subscription via the Developer portal which will become active once approved by the SimplyIOA team.

Developer Account sign up​

SimplyIOA API Developer account sign up​

In order to gain a subscription key to the Sandbox developer portal you must sign up for a developer account.

APIM Sign Up

  1. Visit Sign Up
  2. Provide your details
  3. Review and agree to the Terms of Use
  4. Complete the captcha challenge
  5. Submit the form
  6. Follow the emailed instructions to verify your account.

APIM Email

Subscribe​

Subscribe to Quoting Distribution Partners product and request subscription keys

  1. Visit the Quoting Distribution Partners page / or from Home screen click Explore APIs

    • Click Products on the top menu bar

    APIM Subcribe

  2. Give your subscription a name

  3. Review and agree to the Terms of Use

  4. Click on Subscribe

    APIM User Profile

  5. You will taken to the User profile page where you can review your subscription state

  6. Once approved by the API Team the state will update as ‘Active’ and you can view and use your subscription keys

  7. You can also change name, password or close your account from the user profile page

The SimplyIOA developer portal displays the most up-to-date technical documentation for our API. It also allows users to try out the individual APIs.

APIM APIs

When browsing an API, you will find a “Try it” button against each endpoint:

APIM Try It

This allows a user to call each endpoint, without having to install anything or write code.