Whip Around is a fleet inspection and maintenance software that allows businesses to manage their fleet maintenance needs easily. The Whip Around Public RESTful API V4.0 is an interface that allows customers to integrate with the Whip Around platform and access the features provided by the platform.
This document is a guide for customers who want to utilize the Whip Around Public RESTful API V4.0. The guide provides an overview of the API, how to authenticate, how to make requests, and how to handle responses.
In this article:
Overview of the Whip Around Public RESTful API V4.0
The Whip Around Public RESTful API V4.0 provides a set of endpoints that allow customers to access the Whip Around platform's functionality. The endpoints include:
Asset endpoint - allows customers to manage fleet assets, including creating, updating, and deleting assets.
Defect endpoint - allows customers to manage vehicle defects, including creating, updating, and deleting defects.
Inspection endpoint - allows customers to manage vehicle inspections, including creating, updating, and deleting inspections.
Inventory endpoint - allows customers to manage inventory of parts and supplies needed for vehicle maintenance.
Work Order endpoint - allows customers to create and manage work orders for their fleet vehicles.
Driver endpoint - allows customers to manage drivers, including creating, updating, and deleting drivers.
Service Schedule endpoint - allows customers to manage scheduled maintenance for their fleet vehicles.
The API uses JSON format for requests and responses, and customers can use any programming language to interact with the API.
Authentication
To use the Whip Around Public RESTful API V4.0, customers must first authenticate their requests. Authentication is done through an API key, which is generated by Whip Around for each customer account.
To authenticate a request, customers must include their API key in the HTTP header of the request. The API key should be included in the Authorization header as follows:
Authorization: Bearer {API Key}
Where {API Key} is the API key generated by Whip Around for the customer account.
Making Requests
Customers can make requests to the Whip Around Public RESTful API V4.0 using any programming language that can make HTTP requests. The API supports standard HTTP methods, including GET, POST, PUT, and DELETE.
To make a request, customers must construct a URL that includes the endpoint they want to access and any parameters required for the request. The URL should also include the customer's API key in the Authorization header, as described above.
For example, to get a list of inspections, customers can send a GET request to the inspections endpoint as follows:
The above request will return a list of inspections for the customer account.
Handling Responses
The Whip Around Public RESTful API V4.0 responds to requests with JSON objects. Customers can parse the JSON objects to extract the data they need.
Responses from the API will include an HTTP status code that indicates the success or failure of the request. A successful request will return an HTTP status code of 200 or 201, depending on the request method used. Any other HTTP status code indicates an error.
In case of an error, the response will include an error message in the JSON object. Customers should parse the error message to determine the cause of the error.
Conclusion
The Whip Around Public RESTful API V4.0 provides a set of endpoints that allow customers to access the Whip Around platform's functionality. Customers can authenticate their requests using an API key and can make requests using any programming language that can make HTTP requests. Responses from the API are in JSON format, and customers should parse the JSON objects to extract the data they need.