Forum Discussion

nkm's avatar
nkm
Experienced User
4 years ago

Workflow of myob APIs

Hi, I would like to know more about the whole workflow of the APIs from authentication to calling the API. I understand that when we register as a developer, we will have a sandbox company file and ...
  • Hannah_B's avatar
    Hannah_B
    4 years ago

    Hi nkm, 

     

    Thank you for reaching out. Not a problem at all I am happy to step through the API flow.

     

    An API key is needed to access our APIs. To create an API Key and Secret, you will need to become a registered developer partner with us. Our Open Access program provides free access to the AccountRight Live API and lets you create API keys. Our [getting started guide] (https://developer.myob.com/api/accountright/api-overview/getting-started/) will help you through the registration process.

     

    Once you've registered and your developer account is created, to gain the API key and secret you will need to log into your my.MYOB and click on the developer's tab. To access the Developers tab in your [my.MYOB] (https://my.myob.com.au/Pages/Default.aspx) account you need to make sure that you have the correct account selected on the top right handside. Once you are logged into the my.MYOB website, on the top right-hand side of the screen there is be a drop down menu beside sign out, Make sure that your developer account is selected in this drop-down. Once that is done the Developers tab should appear. From here you need to click on the Register App button and enter in the details relating to your app. [Developer key registration tips](https://apisupport.myob.com/hc/en-us/articles/360001560516-Developer-Key-Registration-TIP).

     

    With your API key and secret, you can begin building your integration to connect Your app + AccountRight. The AccountRight API uses the OAuth 2.0 method to securely provide access to AccountRight company files. Here is the link to our help article which explains the full process of connecting with a company file via the AccountRight API - https://apisupport.myob.com/hc/en-us/articles/360001459455-How-to-Complete-End-User-Authentication-with-OAuth2-0

     

    We also have the AccountRight Postman Collections which has a video on OAuth from within Postman: https://developers.myob.com/api/accountright/accountright-postman-collection/

     

    The developer will need to be invited to the company file so they can access this file through the API.

     

    Our AccountRight sandbox files are shared demo files that we maintain however the New Demo Essentials v2 file is for your own use to test the API. 

     

    Yes that is correct the client can have multiple company files and we can reuse the same key by having multiple redirect URIs - https://apisupport.myob.com/hc/en-us/articles/360000578335-Multiple-Redirect-URLs. 

Hannah_B's avatar
Hannah_B
MYOB Moderator
4 years ago

Hi nkm, 

 

Thank you for reaching out. Not a problem at all I am happy to step through the API flow.

 

An API key is needed to access our APIs. To create an API Key and Secret, you will need to become a registered developer partner with us. Our Open Access program provides free access to the AccountRight Live API and lets you create API keys. Our [getting started guide] (https://developer.myob.com/api/accountright/api-overview/getting-started/) will help you through the registration process.

 

Once you've registered and your developer account is created, to gain the API key and secret you will need to log into your my.MYOB and click on the developer's tab. To access the Developers tab in your [my.MYOB] (https://my.myob.com.au/Pages/Default.aspx) account you need to make sure that you have the correct account selected on the top right handside. Once you are logged into the my.MYOB website, on the top right-hand side of the screen there is be a drop down menu beside sign out, Make sure that your developer account is selected in this drop-down. Once that is done the Developers tab should appear. From here you need to click on the Register App button and enter in the details relating to your app. [Developer key registration tips](https://apisupport.myob.com/hc/en-us/articles/360001560516-Developer-Key-Registration-TIP).

 

With your API key and secret, you can begin building your integration to connect Your app + AccountRight. The AccountRight API uses the OAuth 2.0 method to securely provide access to AccountRight company files. Here is the link to our help article which explains the full process of connecting with a company file via the AccountRight API - https://apisupport.myob.com/hc/en-us/articles/360001459455-How-to-Complete-End-User-Authentication-with-OAuth2-0

 

We also have the AccountRight Postman Collections which has a video on OAuth from within Postman: https://developers.myob.com/api/accountright/accountright-postman-collection/

 

The developer will need to be invited to the company file so they can access this file through the API.

 

Our AccountRight sandbox files are shared demo files that we maintain however the New Demo Essentials v2 file is for your own use to test the API. 

 

Yes that is correct the client can have multiple company files and we can reuse the same key by having multiple redirect URIs - https://apisupport.myob.com/hc/en-us/articles/360000578335-Multiple-Redirect-URLs. 

Looking for something else?

Search the Community Forum for answers or find your topic and get the conversation started!

Community home

Dig into MYOB Academy for free courses, learning paths and live events to help build your business with MYOB.