diff --git a/docs.json b/docs.json index 39175cd..447fc96 100644 --- a/docs.json +++ b/docs.json @@ -39,10 +39,18 @@ "api-reference/fleet-optimization" ] }, + { + "group": "MCP", + "icon": "sparkles", + "pages": [ + "mcp/overview" + ] + }, { "group": "OpenAPI", "icon": "terminal", "pages": [ + "openapi", "openapi.json GET /route/v1/{profile}/{coordinates}", "openapi.json GET /table/v1/{profile}/{coordinates}", "openapi.json GET /match/v1/{profile}/{coordinates}", @@ -58,8 +66,7 @@ "pages": [ "guides/draw-route-on-map", "guides/turn-by-turn", - "guides/sdks", - "guides/mcp" + "guides/sdks" ] } ] diff --git a/index.mdx b/index.mdx index 34b356d..f9c93b8 100644 --- a/index.mdx +++ b/index.mdx @@ -1,46 +1,64 @@ --- title: "JustRouting Docs" -description: "Super lightweight routing APIs for Southeast Asia — directions, distance matrix, and fleet optimization." +description: "Routing APIs for Southeast Asia — directions, geocoding, distance matrices, map matching, and fleet optimization, with car and motorcycle profiles." --- -JustRouting Docs cover routing APIs tuned for Southeast Asia: road-accurate **Directions**, **Distance Matrix**, and **Fleet Optimization**, built on Open Source: OSRM, VROOM, and OpenStreetMap. Standard protocols, zero lock-in. +# JustRouting APIs for Southeast Asia + +**Simple routing APIs for developers and AI agents.** + +Road routing, geocoding, distance matrices, and fleet optimization — with **car and motorcycle profiles**. + +Start in 30 seconds. **$0 to try.** No DevOps, no sales calls, no enterprise contract. - Get a key, make your first request, and draw the route on a map in 3 minutes + Get an API key, make your first route request, and draw it on a map in 3 minutes. + + + Calculate road routes, distance, duration, and turn-by-turn instructions. + + Turn place names and addresses into coordinates and address details. + + + +## Core APIs + + - Routes between two points or ordered waypoints — distance, duration, and turn-by-turn steps + Road-accurate routes between coordinates or ordered waypoints, with distance, duration, geometry, and turn-by-turn steps. - N×N travel time and distance matrix in a single request + Calculate travel times and distances between many origins and destinations in a single request. + + + Convert place names and addresses into longitude, latitude, and structured address details. - Multi-vehicle route optimization powered by VROOM, with time windows and capacity + Optimize multi-vehicle routes with jobs, shipments, capacities, skills, time windows, and other constraints. + + +## Advanced APIs + + - Snap GPS traces to the real road network + Match noisy GPS traces to the road network and recover realistic road paths. - - Official Python, JavaScript, and Go clients — zero dependencies + + Find an efficient route through a set of coordinates, solving a traveling-salesperson-style problem. + + + Find the nearest routable road segment for a coordinate. -## Basics +## Built for developers -| | | -| --- | --- | -| **Base URL** | `https://api.justrouting.tech` | -| **Authentication** | `Authorization: Bearer ` | -| **Coordinate format** | `lng,lat` (longitude first), multiple coordinates separated by `;` | -| **Coverage** | 11 Southeast Asian countries, see [Coverage](/coverage) | -| **Free tier** | 100 requests/day, no credit card required | +Use a simple REST API or official **Python, JavaScript/TypeScript, and Go SDKs**. - - Want to try it in the browser first? Open the [Live Demo](https://justrouting.tech) and drag the markers on the map. - - -## A minimal request +No routing infrastructure to deploy. No map server to maintain. Just call the API. ```bash curl "https://api.justrouting.tech/route/v1/driving/103.708362,1.357371;103.984748,1.352212?overview=full" \ @@ -66,10 +84,82 @@ curl "https://api.justrouting.tech/route/v1/driving/103.708362,1.357371;103.9847 } ``` -No key yet? [Sign up for free](https://justrouting.tech/signup) or jump to the [Quickstart](/quickstart). +[Get a free API key](https://justrouting.tech/signup) · [Read the Quickstart](/quickstart) · [Explore the SDKs](/guides/sdks) + +## Built for AI agents + +JustRouting can be used directly by AI assistants and coding agents through **MCP**. + +Give an AI agent the ability to: + +* Geocode addresses and place names +* Calculate driving routes and travel times +* Compare travel times between multiple locations +* Optimize delivery and fleet routes +* Route for cars or motorcycles + + + + Connect Claude, Cursor, and other MCP-compatible AI clients to JustRouting. + + + Use the machine-readable API specification with code generators and AI coding tools. + + + + + **REST API for developers. MCP for AI agents. OpenAPI for machines.** + + +## Southeast Asia coverage + +JustRouting currently provides routing coverage across **11 Southeast Asian countries**: + +Singapore · Malaysia · Indonesia · Thailand · Philippines · Vietnam · Cambodia · Laos · Myanmar · Brunei · Timor-Leste + +See the full [Coverage](/coverage) details. + +## Quick reference + +| | | +| --------------------- | ------------------------------------------------------------------ | +| **Base URL** | `https://api.justrouting.tech` | +| **Authentication** | `Authorization: Bearer ` | +| **Coordinate format** | `lng,lat` — longitude first; multiple coordinates separated by `;` | +| **Routing profiles** | `car`, `motorcycle` | +| **Coverage** | 11 Southeast Asian countries | +| **Free tier** | 100 requests/day, no credit card required | + + + Want to try it in the browser first? Open the [Live Demo](https://justrouting.tech) and drag the markers on the map. + + +## More than an API + +JustRouting is built on proven open-source mapping technology, including **OSRM, VROOM, and OpenStreetMap**. + +You get standard HTTP APIs and open formats without having to run the underlying routing infrastructure yourself. + +**No 128GB server. No ongoing DevOps work. No vendor lock-in.** + +## Start routing + +No key yet? [Sign up for free](https://justrouting.tech/signup) and make your first request in minutes. + + + + Make your first routing request. + + + Explore all APIs and parameters. + + + Give AI agents access to routing. + + ## Need help? -- Source code and SDKs: [github.com/justrouting](https://github.com/justrouting) -- Email: [hello@justrouting.tech](mailto:hello@justrouting.tech) -- Usage and quotas: [Dashboard](https://justrouting.tech/dashboard) +* Source code and SDKs: [github.com/justrouting](https://github.com/justrouting) +* Email: [hello@justrouting.tech](mailto:hello@justrouting.tech) +* Usage and quotas: [Dashboard](https://justrouting.tech/dashboard) diff --git a/guides/mcp.mdx b/mcp/overview.mdx similarity index 100% rename from guides/mcp.mdx rename to mcp/overview.mdx diff --git a/openapi.mdx b/openapi.mdx new file mode 100644 index 0000000..185729f --- /dev/null +++ b/openapi.mdx @@ -0,0 +1,34 @@ +--- +title: "OpenAPI" +description: "Machine-readable specification for the JustRouting API." +--- + +# Overview + +JustRouting provides an OpenAPI specification for developers and tools that +want to discover and integrate the API programmatically. + +The specification describes the available endpoints, parameters, request +schemas, and response schemas. + +## Specification + +[Download openapi.json](https://raw.githubusercontent.com/justrouting/docs/main/openapi.json) + +Use the interactive API explorer below to try JustRouting endpoints directly +from the documentation. + +## Use cases + +The OpenAPI specification can be used with: + +- API clients and code generators +- Postman and similar API tools +- IDEs and AI coding tools +- Automated documentation generators +- Custom integrations and tooling + + +For learning how to use JustRouting, start with the [Quickstart](/quickstart) +or [API Reference](/api-reference/directions). + diff --git a/quickstart.mdx b/quickstart.mdx index 52469c9..fc51348 100644 --- a/quickstart.mdx +++ b/quickstart.mdx @@ -11,7 +11,7 @@ Quickstart takes three steps and three minutes. No credit card required. 2. Log in and open the [Dashboard](https://justrouting.tech/dashboard), then click **Create API Key** 3. Copy the key — it is shown in full only once -## 2. Make your first request +## 2. Get a route Try the route in Singapore (replace the key with your own): @@ -81,7 +81,7 @@ func main() { `routes[0].geometry` in the response is the route geometry (encoded polyline). Distances are in **meters**, durations in **seconds**. -## 3. Draw the route on a map +## 3. Put it on a map Request with `geometries=geojson` and `routes[0].geometry` is a ready-to-use GeoJSON LineString: