Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mapup/tollguru-api-parameter-examples
This repo lists request parameters and corresponding JSON to use with the TollGuru Toll API to receive specific responses.
https://github.com/mapup/tollguru-api-parameter-examples
fuel-calculator-service gps-tracking route-optimization toll-api toll-calculator tollguru trip-planner
Last synced: 16 days ago
JSON representation
This repo lists request parameters and corresponding JSON to use with the TollGuru Toll API to receive specific responses.
- Host: GitHub
- URL: https://github.com/mapup/tollguru-api-parameter-examples
- Owner: mapup
- Created: 2023-12-21T12:34:41.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-14T18:55:55.000Z (4 months ago)
- Last Synced: 2024-08-15T19:12:52.218Z (4 months ago)
- Topics: fuel-calculator-service, gps-tracking, route-optimization, toll-api, toll-calculator, tollguru, trip-planner
- Language: JavaScript
- Homepage: https://tollguru.com/toll-api-docs
- Size: 663 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TollGuru API Parameter Examples
This repository provides examples of how to interact with the TollGuru API. The TollGuru API offers a comprehensive suite of tools for calculating toll costs for various routes and vehicles, providing accurate and efficient toll pricing information. This guide will help you understand how to use the provided examples to integrate toll calculations into your applications.
## Table of Contents
- [Project Description](#project-description)
- [Installation](#installation)
- [Usage](#usage)
- [Features](#features)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Additional Resources](#additional-resources)
## Project Description
The TollGuru API allows developers to calculate toll costs for different routes based on vehicle parameters and toll policies. This API is useful for various applications, including fleet management, trip planning, and logistics. With support for different vehicle types and configurations, the API provides flexible and accurate toll calculation.
Key features include:
- **Route Calculation**: Determine toll costs for specified routes.
- **Vehicle Parameterization**: Customize calculations based on vehicle type, fuel cost, tag cost, and more.
- **Multi-Route Support**: Compare toll costs for multiple routes to find the most cost-effective path.
For a comprehensive overview of the TollGuru API, please visit the [TollGuru API Documentation](https://www.tollguru.com/toll-api-docs).
## Installation
To use the examples in this repository, clone the repo to your local machine and install the necessary dependencies.
```bash
git clone https://github.com/mapup/tollguru-api-parameter-examples.git
cd tollguru-api-parameter-examples
npm install
```
## Usage
The repository includes several example scripts that demonstrate how to interact with the TollGuru API. Each example showcases different functionalities of the API.
### Example: Calculate Toll Costs
```javascript
const axios = require('axios');
const calculateToll = async () => {
const response = await axios.post('https://api.tollguru.com/v1/calc/route', {
source: {
lat: 37.7749,
lng: -122.4194
},
destination: {
lat: 34.0522,
lng: -118.2437
},
vehicleType: "2AxlesAuto",
departure_time: "2023-08-01T12:00:00Z"
}, {
headers: {
'Content-Type': 'application/json',
'x-api-key': 'YOUR_API_KEY'
}
});
console.log(response.data);
};
calculateToll();
```
Replace `'YOUR_API_KEY'` with your actual API key. This example demonstrates how to calculate toll costs for a route between San Francisco and Los Angeles for a 2-axle automobile.
### Example: Vehicle Parameters
```javascript
const axios = require('axios');
const getVehicleParameters = async () => {
const response = await axios.get('https://api.tollguru.com/v1/vehicle-types', {
headers: {
'Content-Type': 'application/json',
'x-api-key': 'YOUR_API_KEY'
}
});
console.log(response.data);
};
getVehicleParameters();
```
### Example: Route Preferences
```javascript
const axios = require('axios');
const calculatePreferredRoute = async () => {
const response = await axios.post('https://api.tollguru.com/v1/calc/route', {
source: {
lat: 40.7128,
lng: -74.0060
},
destination: {
lat: 34.0522,
lng: -118.2437
},
vehicleType: "2AxlesAuto",
departure_time: "2023-08-01T12:00:00Z",
preferred_routes: ["fastest", "shortest"]
}, {
headers: {
'Content-Type': 'application/json',
'x-api-key': 'YOUR_API_KEY'
}
});
console.log(response.data);
};
calculatePreferredRoute();
```
## Contributing
We welcome contributions to this repository! If you have suggestions or improvements, please open an issue or submit a pull request.
1. Fork the repository.
2. Create a new branch (`git checkout -b feature-branch`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add new feature'`).
5. Push to the branch (`git push origin feature-branch`).
6. Open a pull request.
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
## Contact
For any questions or support, please reach out to [[email protected]](mailto:[email protected]).
## Additional Resources
For a comprehensive overview and additional details, refer to the following sections of the [TollGuru API Documentation](https://www.tollguru.com/toll-api-docs):
- [API Overview](https://www.tollguru.com/toll-api-docs#api-overview)
- [Authentication](https://www.tollguru.com/toll-api-docs#authentication)
- [Endpoints and Parameters](https://www.tollguru.com/toll-api-docs#endpoints-and-parameters)
- [Calculate Toll Costs between start, to, waypoints](https://www.tollguru.com/toll-api-docs#tolls-between-origin-destination-and-waypoints)
- [Calculate Toll Costs for an encoded polyline](https://www.tollguru.com/toll-api-docs#route-encoded-polyline)
- [Calculate Toll Costs from a GPS track](https://www.tollguru.com/toll-api-docs#tolltally---gps-tracks-to-toll-api)
- [Vehicle Types](https://www.tollguru.com/toll-api-docs#vehicle-types-supported-by-tollguru)
- [Error Handling](https://www.tollguru.com/toll-api-docs#errors-and-troubleshooting)
- [FAQ](https://www.tollguru.com/toll-api-docs#faq)