Following signing of the APIv3 services agreement. All custom builds and plugins connecting to SAM via APIv3 are required to request login access to the APIv3 for each of their Art centres. You will first get access to a test area set up specifically for each art centre. it will have a copy of the art centres SAM data, from when they migrated to New SAM. This is called the User Testing area (UAT). This is where you test the API and new integrations, and plugins. This MUST be done FIRST. Note: This process can take 24-48hrs to complete.
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.
To start this process, please email help@sam.org.au with the following and then follow the instructions below:
| 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 | UAT |
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.