#Access Route4Me's logistics-as-a-service API using our C++ SDK
This SDK makes it easier for you use the Route4Me API, which creates optimally sequenced driving routes for many drivers.
The service is typically used by organizations who must route many drivers to many destinations. In addition to route optimization for new (future) routes, the API can also be used to analyze historical routes, and to distribute routes to field personnel.
The Route4Me SDK and API cannot be resold or used in a product or system that competes directly with Route4Me. This means that developers cannot resell route optimization services to other businesses or developers. However, developers can integrate our route optimization SDK/API into their software applications. Developers and startups are also permitted to use our software for internal purposes (i.e. a same day delivery startup).
A Route4Me customer, integrator, or partner incorporates the Route4Me SDK or API into their code base. Route4Me permits any paying subscriber to interact with every part of its system using it’s API. The API is RESTful, which means that it’s web based and can be accessed by other programs and machines The API/SDK should be used to automate the route planning process, or to generate many routes with minimal manual intervention
Every Route4Me SDK instance needs a unique API key. The API key can be retrieved inside your Route4Me.com account, inside the Settings tab called API. When a route is planned, it appears inside the corresponding Route4Me account. Because Route4Me web and mobile accounts are synchronized, the routes will appear in both environments at the same time.
No. The sample API key only permits you to optimize routes with the sample address coordinates that are part of this SDK.
The number of requests you can make per second is limited by your current subscription plan. Typically, there are different rate limits for these core features: Address Geocoding & Address Reverse Geocoding Route Optimization & Management Viewing a Route
There are two typical integration strategies that we recommend. Using this SDK, you can make optimization requests and then the SDK polls the Route4Me API to detect state changes as the optimization progresses. Alternatively, you can provide a webhook/callback url, and the API will notify that callback URL every time there is a state change.
I don't need route management or mobile capabilities. Is there a lower level Route4Me API just for the optimization engine?
Yes. Please contact support@route4me.com to learn about the low-level RESTful API.
Most routes having less than 200 destinations are optimized in 1 second or less.
Yes. You can send routes with optimization disabled if you want to conveniently see them on a map, or distribute them to your drivers in the order you prefer.
Yes. The API can accept lat/lng and an unlimited amount of per-address metadata. The metadata will be preserved as passthrough data by our API, so that the receiving device will have access to critical data when our API invokes a webhook callback to the device.
Yes. All routes are permanently stored in the database and are no longer accessible to you after your subscription is terminated.
Route4Me’s route planning and optimization technology can only be added into applications that do not directly compete with Route4Me. This means the application’s primary capabilities must be unrelated to route optimization, route planning, or navigation.
Yes
White-labeling and private-labeling Route4Me is possible but the deal’s licensing terms vary considerably based on customer count, route count, and the level of support that Route4Me should provide to your customers.
Route4Me is currently working on these features but they are not currently available for sale.
Can the API/SDK send notifications back to our system using callbacks, notifications, pushes, or webhooks?
Because Route4Me processes all routes asynchronously, Route4Me will conveniently notify the endpoint you specify as the route optimization job progresses through each state of the optimization. Every stage of the route optimization process has a unique stage id.
Route4Me.com, as well as all of Route4Me’s mobile applications use the Route4Me SDK’s and API. Since Route4Me works globally, this means that all of Route4Me’s capabilities are available using the SDK’s in every country
Customers are encouraged to select their preferred operating system environment. The Route4Me API/SDK will function on any operating system that supports the preferred programming language of the customer. At this point in time, almost every supported SDK can run on any operating system.
Route4Me has its own computing infrastructure that you can access using the API and SDKs. Customers typically have to run the SDK code on their own computers and/or servers to access this infrastructure.
Route4Me does not currently lease or sell servers, and does not have on-premise appliance solution. This would only be possible in exceptionally unique scenarios.
The time required to integrate the SDK can be as little as 1 hour or may take several weeks, depending on the number of features being incorporated into the customer’s application and how much integration testing will be done by the client. A programmer’s involvement is almost always required to use Route4Me’s technology when accessing it through the API.
Route4Me API C++ client depends on libcurl library, needed for client-side URL transfers. Before you can build the source, you need to install libcurl, e.g.: for Ubuntu it would be advisable to update your repositories and then proceed with
sudo apt-get install libcurl4-openssl-devIf you want to know a bit more about libcurl, you should go on the official website and read about interfaces that cURL implements: http://curl.haxx.se/
Route4Me API C++ client uses jsoncpp library to manipulate with JSON; all needed source files are already inserted into the project of Route4Me API C++ client, and no additional actions are expected from the user.
To build Route4me API C++ client as a standalone library
cd build
cmake ..
makeThis will create a library in lib/ and build examples from test/
Then add <Route4Me API C++ root>/lib/ to your library path and <Route4Me API C++ root>/include/ to your include path.
When linking, link against route4me (e.g.: g++ example.cpp -o example -lroute4me).
Route4Me API C++ client comprises 2 core files:
- src/route4me.cpp - api calls/wrappers
- include/route4me.h - defines and class interfaces
and additional source files test/*.cpp containing exhaustive samples for each section of Route4Me API:
// global init
CRoute4Me::init(); // need this to use libcurl global init
// create an api wrapper object
CRoute4Me route("11111111111111111111111111111111");
// define a problem that we are to solve
Json::Value params(Json::objectValue);
params["route_name"] = "Single Driver Round Trip";
params["algorithm_type"] = CRoute4Me::TSP;
params["remote_ip"] = 0;
params["member_id"] = 1;
params["route_time"] = 0;
params["route_max_duration"] = 86400;
params["optimize"] = "Distance";
params["distance_unit"] = "mi";
params["travel_mode"] = "Driving";
params["store_route"] = 1;
params["device_type"] = "web";
params["vehicle_capacity"] = 1;
params["vehicle_max_distance_mi"] = 10000;
params["directions"] = 1;
// read addresses from a json file
Json::Value addr;
ifstream inf("addr.json");
inf >> addr;
// query to solve the optimization problem, defined in params
if(route.run_optimization(addr, params) == 0)
{
// use Json::StyledWriter instead of Json::FastWriter for a human friendly output
cout << "Single driver round trip:" << endl << Json::FastWriter().write(route.get_json_resp()) << endl;
}
else
{
// there is an error code and an error message in a human friendly format
cout << "Err: " << route.get_err_code() << ": " << route.get_err_msg() << endl;
}
// global cleanup
CRoute4Me::cleanup(); // need this to use libcurl global cleanup const char *KEY = "11111111111111111111111111111111";
// global init
CRoute4Me::init();
// create an api wrapper object
CRoute4Me route(KEY);
if(route.get_route_q() == 0)
{
Json::Value opt_lst = route.get_json_resp()["optimizations"];
if(opt_lst.isArray())
{
std::cout << "Key = " << KEY << "; Optimization problems are:" << endl;
for(unsigned i = 0; i < opt_lst.size(); i++)
{
string id = opt_lst[i]["optimization_problem_id"].asString();
int state = opt_lst[i]["state"].asInt();
cout << " " << id << " in state " << state << endl;
}
}
}
else
{
cout << "Err: " << route.get_err_code() << ": " << route.get_err_msg() << endl;
}
// global cleanup
CRoute4Me::cleanup();Please see test/*.cpp for more examples, which are to demonstrate examples of Route & GPS calls and some optimization problems (single driver, round trip, multiple driver, time window, re-optimization).