Getting Started

  Date Updated: Oct 25th 2013

So you want to integrate with the MYOB EXO API - fantastic. Lets walk through what you need to do to get up and developing against our API.

1

Get API Access

The first thing you'll need to do is sign up for API access. Do that by clicking the button below - it's free

2

Get your API Keys

Once you have access, you'll need to register your 'app' and receive an API Key and API Secret. You do this via the my.myob portal.

3

Activate your Keys

One the API key is generated, you will then need to email it to developers@myob.com and request that it be activated for EXO.

Now you have access & keys, check out our documentation to get you up and running fast!

API Access?

On Premise or via the Cloud?

MYOB EXO API  is a hybrid product, this means that the you can connect to the API directly on premise or via the cloud.

This gives you the developer two choices when thinking about working with our app. Will your solution (or integration) access the API locally, via the cloud or both?

For example: if you are building a Windows 8 Reporting app, then you'll probably want to access the API locally. If you intended to build an mobile application then you'll want to access the API via the cloud.

The two API's are actually identical, the only difference is the address (URI) the application uses.

How to Access?

Using this API is really simple, as long as you have MYOB EXO Business API installed on premise you can start developing against the API.

Installing API Locally

Run the EXO API Service Installer on the server which will act as the API host. After installation run the Service Configuration Application to configure API settings for each database you want to connect too. Take note of the address and port as you'll need these when accessing the API locally.

The next step is to open up your browser (we recommend a modern browser like Google Chrome) and enter the following address:


http://[IP ADDRESS OF COMPUTER TO ACCESS]:[PORT]/discovery

This should open up a webpage and show you a list of all the API endpoints for that system.


Set up your Authentication Headers

Now you have the API installed you need to obtain your authentication tokens. These are used to identify the application, user, system/database etc. These need to be present in each request. See the authentication page for more details.


Accessing the API via the Cloud

You can also access the API via the cloud. To do this run the Service Configuration Application and configure the LiveRelay Service to connect to each database you want to access. Once configured the only change you need to make is point your application to exo.api.myob.com. 


https://exo.api.myob.com/discovery