Reference · built on requestConnectorFleet & telematics

Route4Me

Route optimization problems, routes, addresses, orders, vehicles, and GPS tracking from Route4Me.

About

Route4Me is a route planning and optimization service. Its API at https://api.route4me.com solves an Optimization Problem, a set of addresses with time windows, depots, and constraints, into one or more Routes, each for a single vehicle and driver. It also holds the Address Book, Orders, Members, Vehicles, Territories, Avoidance Zones, Notes, and an Activity Feed of everything that changes on a route.

Through Fibric, an operator reads routes, driver progress, and activity feed entries, then proposes a new optimization, an inserted or moved stop, or a route note for your approval. Nothing is sent to Route4Me until you approve, and each approved change is recorded once.

This is a reference listing. It documents what Fibric would read from Route4Me and what it could propose, based on the vendor's published interfaces. Fibric builds it under a managed deployment when you request it; selecting it here installs nothing.

Inputs

  • Optimization problems and their resulting routes through /api.v4/optimization_problem.php and /api.v4/route.php
  • Route addresses with sequence numbers, time windows, and visited or departed flags through /api.v4/address.php
  • Orders, the Address Book, and address book groups through /api.v4/order.php and /api.v4/address_book.php
  • Members, vehicles, territories, and avoidance zones through /api.v4/user.php, the v5.0 vehicles endpoint, /api.v4/territory.php, and /api.v4/avoidance.php
  • Device GPS history per route through /api/track/get_device_location.php and current member locations through view_user_locations.php
  • Activity feed entries such as destination out of sequence, driver arrived early or late, and geofence entered or left through /api/get_activities.php
  • Notes with attachments, coordinates, and timestamps on routes and addresses

Proposed actions

  • Target capability: propose a new optimization problem from a set of addresses and constraints, or an inserted address with reoptimization
  • Target capability: propose moving a destination to another route through /actions/route/move_route_destination.php, or merging routes
  • Target capability: propose marking an address visited or departed through update_address_visited.php and mark_address_departed.php
  • Target capability: propose a route note with location and attachment through /actions/addRouteNotes.php
  • Target capability: propose a vehicle record change through the v5.0 vehicles endpoint

Proposed actions are target capabilities. Every action runs propose-first and needs a validated deployment and the appropriate permissions.

What you can build

  • Re-run the plan when orders change

    New orders land in the Address Book after routes are built. The operator proposes inserting them into the optimization problem with reoptimization and shows the changed sequence per route before anyone approves.

    With Route Resequence

  • Notice a skipped stop

    The activity feed records destination out of sequence and driver arrived late. The operator matches them to the route and proposes a call to the driver or a resequenced route.

    With Missed Stop

  • Split a route that will not finish

    Routes carry time windows, visited flags, and device GPS history. When the remaining stops cannot be reached inside their windows, the operator proposes moving destinations to another route.

    With Route Overflow

  • Assign the right vehicle and driver

    Members and vehicles sit beside each route. The operator proposes the driver and vehicle alias for a route and records who approved it.

    With Field Dispatch

Requirements

  • A Route4Me account with API access and its API key from the Settings tab called API
  • JSON request bodies with Content-Type: application/json on POST calls
  • A subscription plan sized for your request rate, since requests per second are limited by plan
  • Real addresses and account data; the sample key only optimizes the sample coordinates shipped with the SDKs
Authentication
A 32-character API key from My Account, API in your Route4Me account, passed as the api_key query parameter on every request.

Limits

  • Requests per second are limited by your subscription plan; no figures are published
  • The API key is sent as a query string parameter rather than a header
  • This listing reads change events from the Activity Feed; it does not use webhooks
  • Duplicating a route does not copy notes or visited status flags

Access and pricing

Reference listing. Fibric builds the connector under a managed deployment when you request it. Your quote covers the build, capabilities, usage, and support.

Request Route4Me ↗

Questions and answers

How do I authenticate?
Every request carries your API key as the api_key query parameter, a 32-character string found in your Route4Me account under My Account, API. The demo key in the documentation only works with the sample addresses.
What is the difference between an optimization problem and a route?
An Optimization Problem is the full set of addresses and constraints to be visited. Solving it produces one or more Routes, each a sequence of addresses for a single vehicle and driver over a fixed period. Route4Me recommends putting as many orders as possible in one problem.
How do I see what drivers did?
The Activity Feed at /api/get_activities.php lists route modifications, note additions, and driver progress by activity_type, such as destination out of sequence, driver arrived early or late, and geofence entered or left. GPS history per route comes from /api/track/get_device_location.php.
Ask about Route4Me

Ask about the capabilities and requirements in this listing.

For project-specific requirements, contact Fibric.