How to Login to the API

The SAM API is an interface to SAM that can be used by web stores to sell Art Centre inventory directly to people online. As such, only web stores and web developers typically need to be able to log in to SAM API itself.

However Art Centre mangers and other staff involved with building and maintaining a web store will sometimes need to check that their API login name and password is correct and working fine. The instructions here will help you do so.

If you are just looking to log into SAM itself, and do not need access to the API, you can always log in here:

• Live / production: https://new.sam.org.au
• Sandbox / UAT: https://uat.sam.org.au

Step 1 - Get your API login name and password

First off, to log in to the SAM API, you will need to have already signed the SAM API Services Agreement. If you have not already done so, you will need to start from top.

Once you have signed the SAM API Services Agreement, we will send you an email with your SAM Sandbox/UAT API login name, a temporary password, and a link to reset the password with one of your choice.

If you have signed the SAM API Services Agreement, and you have not already received an API login name and password via email, please get in touch at: help@sam.org.au

Later on, when your web store is set up and tested using the Sandbox/UAT environment and is ready to start selling real artworks, we will also send you a separate Live/Production API login name that your web developer can use to switch your web store over. The same instructions here also apply for testing your Live/Production API login name and password.

Step 2 - Log in using the interactive API documentation

With your API login name and password in hand, do the following:

1. Open the API documentation in your web browser https://apiv3.sam.org.au
2. In the left-hand navigation pane, under Endpoints, click:
   1. Authenication, then
   2. Login_1
3. On the right, select the SAM environment that matches the API key you are testing:
   1. If the API login is for the Sandbox/UAT, select "Sandbox (UAT)"
   2. if the API login is for the Live/Production environment, select "Live"
       
4. In the Body field as shown above:
   1. On the same line as username, replace string with your API login name, keeping the quotes ("…")
   2. On the same line as password, replace string with your API password, also keeping the quotes
      
5. Click the blue Send API Request

If the login name and password you provided matches the same details stored in the given SAM environment (Sandbox or Live), you will see a 200 OK message such as the one below.

If so, congratulations, you are done! Your API login name and password can successfully be used to log into the SAM API.

If not, you will see a 400 Bad Request message:

If you get this response, double check your API login name and password matches the one in the Body field, and try again.

If that does not help, please get in touch at: help@sam.org.au