Our API is very simple, it is RESTful, which means it is centered around data and simple operations to manage the data. Our API documentation uses Swagger which allows you to easily create and test our various web requests.
We have documented more than 30 API entities, like Ticket, Estimate, Appointment, etc. to be used.
Table of Contents:
Link to Swagger API Docs: http://api-docs.syncromsp.com/
You can also access Swagger by heading to Admin > API > Documentation.
To get set up with Swagger, you will first need to add your Syncro subdomain and authorize your API key.
You can grab your API key in Syncro by heading to your profile page here:
And then grabbing the API key here:
Now you can paste your API key into swagger and authorize to continue:
Your API key will now be logged in and you can begin to use Swagger.
To get started with Swagger, select any web request to view the required parameters and hit 'try it out'.
The parameters will vary for each web request and some may not require any. There will also be a description for each parameter explaining what data should be entered.
Once the parameters have been entered you can select the "Execute" button to run the request.
Swagger will now show you if the request was successful and the response with an example of the output that the request will produce. It will also produce a curl that can be used to get the same response you see in Swagger:
Q: What's the API Rate Limit
A: 120 requests per minute (per IP address)