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 API Docs: https://api-docs.repairshopr.com/
The Documentations can also be accessed from that Admin page inside of RepairShopr. Simply head to admin and scroll down the left-hand side nav to the API section and click "Documentation."
To get your API Token log in to your account and in the upper right of the page, click your name and a drop down menu will appear. Click on Profile/Password.
On the next screen there is a API Token link that you can click to be taken to the API management screen.
You will be taken to the API Token management screen where you can do things like manage existing Tokens, Clone them, or Delete them as necessary.
Clicking New Token will take you to a screen where you can choose from preconfigured tokens or to create a Custom Permission Token.
Custom Permissions allow you to choose what access on your account the token will have. You can also choose an expiration date for the token at this point as well.
IMPORTANT NOTE: When creating a API Token, the full token is only shown in full on the next step. It's at this point that you would want to copy/paste the token to where you are wanting to use it. When you click Done, you will only be able to see the truncated version.
To get set up, you will first need to add your Repairshopr subdomain and authorize your API token. See the above section on how to do that. Now you can paste your API key and authorize to continue:
Your API key will now be logged in and you can begin to use the API.
To get started, 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.
The API 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.
Q: What's the API Rate Limit?
A: 180 requests per minute (per IP address)