API stands for Application Programming Interface. In this context, "Application" refers to any software with a specific function. The "interface" serves as a contract of service between two applications, defining how they communicate through requests and responses.
In simple terms, an API allows an external computer system to interact directly with SASSIE.
Get set up!
While sAPI (Sassie API) has no cost, there are a few setup steps you will need to go through!
Request the needed details
First, open a Support Tracker and request Client API access. Include the following details:
- Client name
- Client ID
- Manager Name
- Manager ID (the manager must have System Admin or Client Master access).
Set up the Token
Once you obtain the details needed, open your preferred API platform (such as Postman, which we used in the examples).
In the "Authorization" tab, select OAuth 2.0 for Type.
Move to the "Configure New Token" section and, fill in the fields under the Configuration Options.
Token Name: The name you can give to the token
Grant Type: set as "Client Credentials"
Access Token URL: https://www.sassieshop.com/2xx/sapi/api/token - in place of xx you will put your system's abbreviation
Client ID: the client_id you have received in the Tracker
Client Secret: the client_secret you have received in the Tracker
Client Authentication: set as "Send as the Basic Auth header"
Hit the Get New Access Token button.
Use the API
Once everything has been set up, you can click the Use Token button, and you should be ready to send API requests using GET, POST and DELETE methods.
Keep up to date!
Remember you can prowl through the API documentation to get all the information you, or your clients, might need!
You will need to update the below links with your system's abbreviation:
Admin documentation - https://www.sassieshop.com/2xx/sapi/docs/
Client documentation - https://www.sassieshop.com/2xx/sapi/client/docs/
An example would be: https://www.sassieshop.com/2su/sapi/docs/
There is also a Tech Talk Video that might be of use!