RepairCenter API version 2.2
The RepairCenter API version 2.2 is now available for use in our UAT environment. Note that the existing 1.5 and 2.1 versions are still fully functional, and we will continue to support these versions. However, the 2.2 version is the future direction of our API, and all future enhancements will be made to the 2.2 version and higher. We hope you're as excited as we are about this new API version, and we look forward to supporting your development efforts!
-Your API Support Team!
What's new:
Portal
The first thing you'll notice about the 2.2 API is the brand new Developer portal. This new portal boasts several great new features:
- Self registration: You can now register as a partner and begin exploring the RepairCenter API's at your own leisure.
- API usage trends: Track and review your recent API usage; is your app optimized for minimal bandwidth and high performance?
- API Console: Not sure what your API request and response should look like? Use the console to test it out!
- Dynamic Documentation: No more static files and out of date documentation. The latest and greatest will always be posted on the portal.
- Feedback: Missing something? Submit your feedback and let us know how we can improve your experience!
Security Model
- The 2.2 API has swapped out the platform auth_certs for a simpler, more intuitive security model. Each app is assigned an App Key, each app key is assigned to a set of appID's, and each set of appID's are licensed at a shop. Simply pass in the App Key and valid appID to retrieve shop data. Note that you still need to authenticate the token from RepairCenter, but you no longer need a token to hit our API.
- Click here to see the new security model diagrams
Consolidated Data Model
- The 2.2 API has consolidated the # of services in order to reduce the # of calls necessary to retrieve job data. The consolidation of services also allows for more LINQ queries and more targeted data retrieval.
- In consolidating the data model, we also took this opportunity to rename a few of the fields. Please carefully review the full consolidated data model change log. Click here to see the full set of consolidated data model changes
Void Flag
Partners can now identify VOIDED jobs by the VOIDED boolean field within the RepairOrder/JobService/Jobs entity.
User Permissions
User permissions are now available via the Shop/ShopService/Useres entity, GroupNames field. This field is a comma delimited list of all security groups that the user is a part of.
Warranty
The RepairOrder/AccountingService/Payments entity and has been separated out into two entities within the RepairOrder/JobService - the Payments entity and the Accounts entity. The Warranty and DirectionToPay fields are now in the Accounts entity, thereby making this data accessible even when no payments exist.
Dates
Job dates are always used in conjunction with the job itself. Therefore, we've removed the RepairOrder/DatesService, and instead added the date fields to the RepairOrder/JobService/Jobs entity
Parts consolidation
Previously, Parts data was stored in two separate entities - RepairOrder/PartsService and RepairOrder/JobService/OrderDetails entity. We've since consolidated these entities into a single entity, the RepairOrder/JobService/Parts entity. The data elements retrieved are securely restricted by Line of Business.
Invoice entity
We've added actual labor cost data in the Invoice entity. This data allows partners to calculate actual labor costs by job, by labor department, and by technician for accurate job costing and profitability. Click here to see the full Invoice entity notes
If you have any questions or concerns about the changes here, please let us know.