API (v3) Set-up for Web Developers
What is SAM?
SAM (Stories Art Money) is an online artwork management system designed specifically for Aboriginal and Torres Strait Islander art centres. It helps with cataloguing artwork, managing artists and products, and functioning as a Point-of-Sale system for artist payments.
About the Rebuild
We've partnered with Symplicit, a design and development expert with a 20-year track record of successful projects, to co-design and develop a new version of SAM.
What is the new SAM API (v3) for?
The new SAM API (v3) new SAM API (v3) will integrate with your online store. This updated API will provide enhanced functionality and streamline your interactions with the new SAM platform.
You will need to update your connection to the new API when moving to the new SAM.
Please ensure this is done prior to your art centre’s onboarding/go live dates – websites that are not ready may cause delays in onboarding.
The API documentation outlines the key functionalities required for managing an online store focused on artworks, editions, and related products. It includes endpoints for catalogue searches, stock availability check and updates, customer creation and managing sales orders.
Please be aware that the new API will replace the existing SAM API (v1) and API (v2).
Currently there is Development SAM access only. This is where you can test the API and any integration.
How to access the new SAM API (v3) Documentation
Please note that you will need to be set up by the Art Centre Manager in the new Production site once your art centre has onboarded to the new SAM.
Using the new SAM API (v3) Documentation
To familiarise yourself with the SAM API (v3) and its capabilities, please review the HTML documentation included below. The HTML provides detailed information about the API endpoints, request/response formats, and usage examples.
SAM (Stories Art Money) is an online artwork management system designed specifically for Aboriginal and Torres Strait Islander art centres. It helps with cataloguing artwork, managing artists and products, and functioning as a Point-of-Sale system for artist payments.
About the Rebuild
We've partnered with Symplicit, a design and development expert with a 20-year track record of successful projects, to co-design and develop a new version of SAM.
What is the new SAM API (v3) for?
The new SAM API (v3) new SAM API (v3) will integrate with your online store. This updated API will provide enhanced functionality and streamline your interactions with the new SAM platform.
You will need to update your connection to the new API when moving to the new SAM.
Please ensure this is done prior to your art centre’s onboarding/go live dates – websites that are not ready may cause delays in onboarding.
The API documentation outlines the key functionalities required for managing an online store focused on artworks, editions, and related products. It includes endpoints for catalogue searches, stock availability check and updates, customer creation and managing sales orders.
Please be aware that the new API will replace the existing SAM API (v1) and API (v2).
Currently there is Development SAM access only. This is where you can test the API and any integration.
How to access the new SAM API (v3) Documentation
- The APIs are documented at apiv3.sam.org.au
- Request web developer access to the Dev SAM environment.
- The requested email will be AWS whitelisted by the Symplicit team
- The SAM team will send temporary login credentials to the Dev SAM environment. The password will need to be reset by clicking "Reset link" in the email.
- Token access key can then be gained by going to apiv3.sam.org.au, navigate to Authentication > /api/v1/auth/login.
- As per the screenshot below, insert Dev SAM credentials from step #4
- Select Server 1
- Click Send API Request
- Copy and use the token response.
Using the new SAM API (v3) Documentation
To familiarise yourself with the SAM API (v3) and its capabilities, please review the HTML documentation included below. The HTML provides detailed information about the API endpoints, request/response formats, and usage examples.
- Review the Documentation: Carefully examine the documentation to understand the API's structure and functionality.
- Integrate the API: Utilise the API endpoints and methods to connect your online store to the SAM platform.
- Test and Validate: Thoroughly test your integration to ensure it functions as expected and provides the desired results.
If further explaination is required, please request a walk-through with the Symplicit development team, by emailing clients@sam.org.au
Any feedback – provide to clients@sam.org.au