Introduction 

Our APIs offer the following benefits:

  • Get started right away: Visit our OSTTRA Developer Portal to find out what our APIs do, how they work and what you need to do to interface with them. Our APIs need just a few lines of code to run in your applications.
  • Be creative: There may be opportunities to shape your API strategy and wider data strategy in ways that you had not previously considered, or access the benefits of API more quickly than was previously indicated.

The OSTTRA Developer Portal contains a wealth of information about our business-ready APIs. We recommend you take some time to familiarise yourself with the portal before starting to build your apps.

Step 1: How to Use
Step 2: How to Go Live
Step 3: Authentication
Step 4: Error Handling
Step 5: Support

How to Use

Registration

To use our API products, just create an OSTTRA Developer Portal account.

Creating an account is quick and easy:

  • Click on Sign Up.
  • Fill in the form with your personal details, including your name, email address and username.
  • Submit the form.
  • You will receive an email with a password reset link after account approval. Click the link, set your password, and you are ready to go.

Explore API products

Want to be inspired and learn what you could build? Our available APIs are displayed on the API Products page. From here you can navigate to the underlying API Overview pages for details of a specific API. Next, go to the Documentation pages for technical information.

How to go live

Once you have tested your application and related proposition(s) in our sandbox environment, you can submit a request to go live.

  • First, when you begin the onboarding process you will get a different Client ID and Client Secret which you can use for your production environment.
  • Contact us to request production access. Depending on the API, our API Services team might contact you to discuss the details of your request.

Authentication

In order to go live you will need an access token. To obtain an access token, you need to query our OAuth 2.0 API.

Environments

These are the URLs for the endpoints to get your tokens.

Sandbox: https://beta.api.osttra.com/oauth2/v1/token

Production: https://api.osttra.com/oauth2/v1/token

OAuth Flows

Our APIs are secured using OAuth 2.0. This means you will need to provide an access token when making your request to the APIs. This page will explain how to obtain an access token. We use the following three fields for requesting an access token: client_id, client_secret, grant_type.

Error Handling

This section provides an overview of the OSTTRA API error model.

Error Format

All OSTTRA APIs returns errors in following JSON format:

{
 "error": {
     "code": "ERROR_UNIQUE_CODE",
     "message": "ERROR_MESSAGE"
 }
}

Support

Questions or problems? We are happy to help. Please check our FAQ page for the answers to frequently asked questions.