The API documentation apiv3.sam.org.au outlines the key functionality required to manage an online store focused on artworks, editions, and related products. It includes endpoints for SAM searches, stock availability checks and updates, customer creation, and sales order management.
Developers are given access to the APIv3 via a test area for each art centre - (UAT). This is where you test the API and new integrations, plugins first.
How to access the new SAM API (v3)
- API v3 access is granted only through a support request. (email help@sam.org.au)
- Users cannot create accounts directly through the system.
- Credentials are issued manually and require a mandatory password reset before first login.
Login Process
Step 1:
- Submit a support request to enable APIv3 access.
- Once the request is approved, the user will first receive an email whitelisting their email address from AWS. Click on the link to verify and reply to help@sam.org.au that it was successful. If you don't see the email check your junk. It will expire after 24hrs.
Step 2:
The user will then receive a second email containing:
- Username
- Temporary password
-
Password reset link
Click the password reset link and reset the password using the provided temporary password:
Enter the Temporary Username & Password provided in the email:
Enter a New Password & Given Name (which will become your username):
After resetting the password, test the call to the API v3 login endpoint using V3 Access Link (https://apiv3.sam.org.au/).
Enter your:
- Newly created Username
- Newly created Password
- Select the relevant environment (UAT – Testing; PROD – Live)
Confirm you have been able to login
Comments
0 comments
Article is closed for comments.