Following signing of the APIv3 services agreement. All SAM - WEB custom builds and plugins via the SAM APIv3 are required to request login access for each Art centre. You will first receive access to a test area called the Sandbox (also known historically as "UAT"), set up specifically for each art centre that allows you to test things such as creating artworks and sales without changing your real data in SAM. This is where you must test the API and new integrations to the art centres online store and any plugins. This MUST be done FIRST - please refer to Process-to-connect-Art-Centre-SAM-to-online-store. Test first in Sandbox/UAT, then switch to Live/Production and repeat the checks.
Note: Access requests can take 24-48hrs to process and complete.
How to request access the new SAM APIv3
- API v3 access is granted only through a support request.
- 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 by emailing help@sam.org.au with the following to enable APIv3 access.
| Required Details | Answer |
|
Art Centre Name Name of Art centre (must be live in New SAM) |
|
|
The API access invitation will be sent to this email address, so please ensure it is accurate and monitored. It must be a unique email for each AC request. Alias is accepted. |
|
|
Name Full name of the individual responsible or contact person for this request. (developer, designer) |
|
|
Webhook URL (only if applicable, NA for Desart plugin) Provide the Webhook URL to be used for API callbacks and notifications. |
|
|
Public Key (only if applicable, NA for Desart plugin) Include the public key that will be used to verify webhook signatures and ensure secure communication. |
|
| Environment | Sandbox (UAT) |
Step 2:
The user will then receive a email (from noreply@verificationemail.com) 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 ("Sandbox" when testing, "Live" for production)
Confirm you have been able to login
Comments
0 comments
Article is closed for comments.