Trips (πŸ‘·β€β™‚οΈ)
Trips allow you to manage broadly defined trips. Whether it's a taxi driver, food/parcel delivery, outdoor run, or anyone else who needs to move from location A to B, Roam.ai location technology helps to manage that process.
Trips use a combination of REST APIs and SDK Methods for the creation and management of trips. Trips can be tracked in real-time using our SDK listener methods, webhook, and our tracking portal track.roam.ai

Base URL

The Roam API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
1
https://api.roam.ai/v1/api/trips
Copied!

Authentication

The Roam API uses API keys to authenticate requests. You can view and manage your API keys in the Roam Dashboard.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. Authentication to the API is performed via a custom header Api-Key. Provide your API key as the value for the header Api-Key
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

SDK Methods

When you interact with your the Trip SDK Methods may require you to use user_id or trip_id while calling the methods.
Text
Description
Roam.startTrip
Allows you to start a "Quick Trip" or a "Planned Trip" with pre-defined origins or destinations.
Roam.stopTrip
Allows you to stop any Trip.
Roam.createTrip
Allows you to create a Planned trip with or without origins and destinations.
Roam.getTripDetails
Allows you to get the trip details using the trip_id.
Roam.pauseTrip
Allows you to pause any Trip.
Roam.ResumeTrip
Allows you to resume any Trip.
Roam.subscribeTripStatus
Allows you to subscribe to the real-time status of any ongoing trip.
Roam.getTripStatus
Allows you to get the latest status of any Trip.
Roam.activeTrips
Allows you to get a list of active trips for a specific user_id.
Roam.getTripSummary
Allows you to get a trip summary which includes the trip route, time taken, distance covered, and more.

​

​
Last modified 29d ago
Export as PDF
Copy link