FAQs

Getting started

How do I get started with ASB API Developer Portal?

What happens when I have an ASB API Developer Portal account?

Does it cost anything?

What formats do the APIs support?

How do I get an API key?

Are there other ASB APIs apart from those available on the portal?

Managing applications and APIs

Getting started

How do I get started with ASB API Developer Portal?

Simply register your organisation , or by clicking on the “Sign up” link at the top. You’ll need to fill in your details and those of your organisation, accept the terms and conditions, then click “Register Now”.
We’ll email you as soon as an account has been opened for your organisation. 

What happens when I have an ASB API Developer Portal account?

You become the Organisation Administrator, giving you full authority to manage applications and developers on behalf of your organisation. 
You can invite your own developers to use the portal, get API keys, test APIs, manage applications and more. More details here

Does it cost anything?

Our standard plan is free. If you’d like extra functionality or increased usage limits you may be able to upgrade to our Premium plan. Please talk with your ASB Representative about this.

What formats do the APIs support?

All our APIs support a wide range of clients, including Windows, Mac, Web, iOS, Android, or your own custom client. We also support a range of languages including Javascript, Python, PHP, Java, Curl, .Net, Node, Objective C and Ruby.
 

How do I get an API key?

When you add a new application to your ASB API Developer Portal account, you automatically receive an API key for your application. You’ll find this API key on the Applications page of your Dashboard. 

Are there other ASB APIs apart from those available on the portal?

Our development team is constantly innovating new and exciting APIs so please ask us about these.
 

Which browser should I use?

We have tested various browsers and would recommend one of the following:

Windows:
Firefox version 26.0 or higher
Google Chrome Version 37.0 or higher

Mac:
Safari Version 6 or higher
 

Managing applications and APIs

What are the Organisation Administrator’s responsibilities?

The Organisation Administrator is your company’s representative for the ASB API Developer Portal. This person has overall responsibility for the ASB API Developer Portal account, and has access to all the services and functions available on the site.
The Organisation Administrator’s main responsibilities include:
  • Adding, deleting and managing your organisation’s developers
  • Adding, deleting and managing your organisation’s applications
  • Editing organisational details
  • Requesting API keys and authentication
  • Changing API Plans or Account Plans
  • Checking API usage and analytics.
The Organisation Administrator is ASB’s first point of contact regarding the ASB API Developer Portal.

What responsibilities do Developers have?

Developers have to be invited by their Organisation Administrator to join the portal. Once joined, they can access most of the same functions as the Organisation Administrator.
There are a few things developers won’t be able to do, and this includes inviting other developers to join, changing API or Account plans, or editing organisational details.

What are your Account Plans?

Your organisation has a choice of two Account Plans:
  • Our Standard Plan is a free service that gives you up to 10,000 hits per day over your applications and standard technical support through our portal.
  • Our Premium Plan is a chargeable service that gives you a higher number of hits per day or hour - with enhanced, personalised technical support as well as the standard support available through our portal.

How do I change Account Plans?

If you’re an Organisation Administrator, you can change your Account Plan by going to Dashboard/Applications. Simply select your preferred plan under ‘Account Plan Change’ in the first table. We’ll automatically be notified of your request and be in touch with any further requirements we may need from you.

How do I move from Sandbox to Production?

If you’re an Organisation Administrator, you can request to move from Sandbox to Production for each API within a specific application using this portal:
1. Go to Dashboard/Applications. 
2. Click on the cog icon next to your application and select ‘Edit’.
3. Click on the ‘API Management’ tab.
4. Under ‘API Plan Change’ select ‘Production’.
We’ll then be in touch with any further requirements we may need from you.

If I delete an application, can I retrieve it?

No, so please make sure you’re certain you don’t want the application before deleting it. 

Can I put my application on hold, but keep my account open?

Yes. Go to Dashboard/Applications, click on the cog to the right of the application, then ‘Disable’.

Does my API key expire?

No. But your Application may be suspended or deleted which will suspend or delete the associated API key.

 

Troubleshooting

I can’t log in.

If you’ve registered with the ASB API Developer Portal you should be able to log in the user name and password you provided during registration.
  • Check that your username and password are correct – remember, the system is case sensitive.
  • If you’ve forgotten your password, click on the link in the error message and we’ll send a temporary password to your email.
  • If you’re a developer, check with your Organisation Administrator that your log in hasn’t been suspended.
If you can’t remember your username and password, or you’re using the correct username and password, but still can’t log in,  please contact:APITeam@asb.co.nz

I’ve forgotten my username or password.

  • If you’ve forgotten your username, please contact APITeam@asb.co.nz and we’ll reset it for you.
  • If you’ve forgotten your password, click on the link in the error message and we’ll send a temporary password to your email.

No sample code is available, or it’s invalid, when I test the API.

Try these:
  • Have you added that specific API to your application? The API you want to test must be added to your application for you to test it. To add an API to your application:
  1. Go to Dashboard/Application.
  2. Click on the cog next to the relevant application and select ‘Edit’.
  3. Click on the ‘API Management’ tab and select the API you’d like to add (bottom left).
  4. Accept the terms and conditions and click ‘Save’. You can now test the API. 
  • Did you execute your request correctly? You must click on ‘Execute Request’ for every request you’re testing.
  • Did you enter the correct value for the parameter? Check that the value corresponds with the specific API by viewing the specifications for that API. 

My API key isn’t working.

Your API key may be invalid because:
  • You no longer have access to the portal or a specific application or API
  • Your Application and associated API key may have been suspended. Please check with your Organisation Administrator or contact: APITeam@asb.co.nz

I keep getting a ‘Bad Request’ error message.

There could be many reasons why you’ve received a Bad Request message. Please check out list of Error Codes for details.