This page gives the information on how to start using RouteStripe API.
Getting Started
The RouteStripe API key is required for all API calls. Follow these steps to set up and start using the API:
-
Sign In or Create an Account
Visit RouteStripe Sign-Up Page and log in or create a new account.
-
Create a Company
In your dashboard, create or select a company for which you want to use the RouteStripe API.
-
Access the API Section
Navigate to the API section in your dashboard side menu to proceed.
-
Copy Your API Key
Copy the API key. Note that the API is available during your trial period.
-
Explore Additional Information
You can view Billing Info and Calculation History in the dashboard for insights into your API usage.
Making API Calls
Authentication
Use your API key for authenticating all requests.
Here is an example of a cURL command to make an API call:
curl --location 'https://routestripe.com/api/route-matrix' \
--header 'api-key: your-api-key' \
--header 'Content-Type: application/json'Request and Response Single Driver Example
{
"fleet": {
"99": {
"load": 0,
"profile": "auto",
"shift_end": "21:00",
"vehicle_id": 55,
"shift_start": "08:00",
"max_distance": 1001000,
"speed_factor": 1,
"start_location": {
"id": "start_location_50.426195_30.538123",
"lat": 50.426195,
"lng": 30.538123,
"name": "start_location_50.426195_30.538123"
}
}
},
"visits": {
"562": {
"end": "20:00",
"load": 0,
"type": "D",
"start": "08:00",
"capacity": 0,
"duration": 5,
"location": {
"lat": 50.424083,
"lng": 30.532379
}
},
"563": {
"end": "20:00",
"load": 0,
"type": "D",
"start": "08:00",
"capacity": 0,
"duration": 5,
"location": {
"lat": 50.472606,
"lng": 30.498047
}
},
"822": {
"end": "20:00",
"load": 0,
"type": "D",
"start": "08:00",
"capacity": 0,
"duration": 5,
"location": {
"lat": 50.466693,
"lng": 30.487747
}
}
},
"options": {
"polylines": true,
"avoid_tolls": false,
"avoid_highways": true,
"squash_duration": "1.00",
"visit_balance_coefficient": 0
},
"country_id": 1
}{
"auth": true,
"num_late_visits": 0,
"num_unserved": 0,
"solution": {
"99": [
{
"distance": 0,
"finish_time": "08:00",
"location_id": "start_location_50.426195_30.538123",
"arrival_time": "08:00",
"location_name": "start_location_50.426195_30.538123"
},
{
"distance": 2.506,
"finish_time": "08:09",
"location_id": 562,
"arrival_time": "08:05",
"location_name": 562
},
{
"distance": 8.33,
"finish_time": "08:29",
"location_id": 822,
"arrival_time": "08:25",
"location_name": 822
},
{
"distance": 4.48,
"finish_time": "08:43",
"location_id": 563,
"arrival_time": "08:38",
"location_name": 563
}
]
},
"status": "success",
"total_break_time": 0,
"total_idle_time": 0,
"total_travel_time": 28,
"total_vehicle_overtime": 0,
"total_visit_lateness": 0,
"total_working_time": 43,
"unserved": null,
"vehicle_overtime": {
"99": 0
},
"total_distance": 15.316,
"polylines": {
"99": [
"orxd_Bczzfy@sDfEgEbGg@f@_DzEsIzJc`@gaAsDgJSg@{@gJvG_I~a@cj@jHsIjHgJzOsS~CgEni@os@v[w`@~CsDnFwG~H_IrIkHnP{Jve@gYnKwGzEkCjHoFzEwGbGkH~W{^rDoF~CrIjHvQvVnn@jCzEvB~CvB~CvVvVnKnKzTbVv[~\\jk@rl@jCjCfYzYzEnFjR~RrD~CRrIsNj_A{Jbo@{@jHsIzh@_Ifh@{@bGoAbGSbBoPzfA{@bGgOr`AwBvLoAfJcBbLoFv[_I~f@oAbLg@jCcGja@sI_D_v@oPkC{@gJwBoPsDsDwBsg@{YwB{@_SgOkCoA{c@_IcBg@fE{OgEzObBf@zc@~HjCnA~RfOvBz@rg@zYrDvBnPrDfJvBjCz@~u@nPrI~C{@bGSvG?fJ?nFRvt@?fOf@ja@f@~Hz@~H~CzO~Wf_Bf@~CbVfuAfJbj@nAvGf@zEzEb[jWv|AvBbL{EvBs]jR??wQzJk\\vQ{JnFsSbLgEvBczBvmAos@n_@cV~M_SnKoZnP{EjCsDvBkf@vV_`Arg@wGrD{^jRkWrNsDnAwGf@kH?gE?o_@RcG?wG?o_@R_IR_I?kR?sN?s]?ce@SsI?kC?w`@?wt@R{Y?cGRoK?{J?oKR_oAnAcGR?jR?f^?bG?nK?nKSbj@?fTSrN?zm@?n_@RjR?rv@Svy@?zO?bG{@zJ{@vLoAjMoA~MoAjMkCnZ{@~HwBnUoAzO_D~\\{@~H{@~HwBvQ{@vGcBnFwBrD_DzEsIjMkbBrfCwB~C{OvV_DzEsDzEwGzJwB~CwLvQkz@bmAcQvVcVr]{EvGcGjH_NfOwGvGwBvBcVjWgOzOsNzO{@z@gTbVcBbBod@jf@_DrD{EzEgTbVwGjHoPvQ{EnFcQ~RcLvLoPvQ_XnZ_D~CsXrIkRzE_Dz@kHjCwGjCcBsIg@cBc[kdA_I_X{@kCoA_DcVwy@oK{^{@wBoAgEsDwL{EoP_Df@sIrIoFnFsDfEoAz@sIzJoAz@wGjHcBbBkCjC{JnKkC~CsXfYsDrDoFvGo_@v`@cQvQsIrI{EnFkR~RcQvQ{JnK{EnF{m@bo@sDz@_Dg@sX_I_]wLoU{J_SkHsN{E_NgEcBg@cVg@oPS_D?{@SRrI?rNRb[f@bQf@jf@?nFRj\\Rz^RzJ?zORnUS~HSvGg@~CoAvGg@z@Sz@sXfw@cBrDkH~RwBnF_I~RoA~CsDnK_IbQcGnKgJnKgEzEcGbGkWvVsNrNwBvBoFfEwBvBgOfOSf@gc@nd@oKnKwQrSoPsl@cVs{@Sg@SkCg@?{@?{@RsD{@gaAkMoA?wQnAcBRg^zJw[nKoKrD_Dz@{J~CoAf@{TrDwQjCkHRoPR?oAf@{^RcLnAgkA_q@_D{J{@{ErDwLnA_SgE{@g@z@f@~RfEvLoAzEsDzJz@~p@~CoAfkASbLg@z^?nAnPSjHSvQkCzTsDnAg@zJ_D~C{@nKsDv[oKf^{JbBSvQoAnA?faAjMrDz@z@Sz@?f@??oZSwhA?sD?cG?kCg@wBg@wBg@cBS{@cBcB_D_DsjAc~@oAwBg@cBg@wBg@cGg@gJg@sSS_IS{ToAchASwLcBolAg@wV?sI?sIf@cGnAsIbBkHf@cBvBcLjHkWfEgOnAgEz@{Ef@gERoF?gToAwt@SwLg@sX{@kk@?wBg@cV{@s]g@{OSkMS{Eg@sl@g@sIoA{JwBsIsIc[cB{E{@_DgE{OsDoP_DoPkCgOkCoPsDgYcBsSg@wLSkHR_IRkHf@wGz@{ErDoPrNgm@vBgJz@gJbGcLRSsNkWcBsD{c@cy@gTg^gY_g@cGcL{@wBcB_D_I{Og@{@sIgO{JwQcB_DcB_DsDnFsDjHoAbB{@nAoAjCoAvBkHfO{h@~dAg@fEg@nAsIzOoAjCgc@fw@_DbGg@nAcBg@{To_@g@oAoAwBwBgEkf@{|@g@cBcB_DoAwBoAcBkCnFg^bo@oKrS{EzJcB~CwBrDsNzY{@bBoFfJ{Yjk@kCnFkHjMwe@f|@cBrDwBfEc`@bt@gOzYg@nA{@nAg@z@{@bB_IzO_DvGoFfJgE~HkWjf@_Nb[cLnUoK~R_IrNoKrSwGvLvB~CvBvGja@jp@zERfTr]~CcBbQnZoFvL"
]
}
}Request and Response Multiple Drivers Example
{
"fleet": {
"99": {
"load": 0,
"profile": "auto",
"shift_end": "21:00",
"vehicle_id": 55,
"shift_start": "08:00",
"max_distance": 1001000,
"speed_factor": 1,
"start_location": {
"id": "start_location_50.426195_30.538123",
"lat": 50.426195,
"lng": 30.538123,
"name": "start_location_50.426195_30.538123"
}
},
"111": {
"load": 100,
"profile": "auto",
"capacity": 5,
"shift_end": "20:11",
"vehicle_id": 1,
"shift_start": "13:01",
"max_distance": 1001000,
"speed_factor": 1,
"start_location": {
"id": "start_location_50.426195_30.538123",
"lat": 50.426195,
"lng": 30.538123,
"name": "start_location_50.426195_30.538123"
}
}
},
"visits": {
"562": {
"end": "20:00",
"load": 0,
"type": "D",
"start": "08:00",
"capacity": 0,
"duration": 5,
"location": {
"lat": 50.424083,
"lng": 30.532379
}
},
"563": {
"end": "20:00",
"load": 0,
"type": "D",
"start": "08:00",
"capacity": 0,
"duration": 5,
"location": {
"lat": 50.472606,
"lng": 30.498047
}
},
"822": {
"end": "20:00",
"load": 0,
"type": "D",
"start": "08:00",
"capacity": 0,
"duration": 5,
"location": {
"lat": 50.466693,
"lng": 30.487747
}
}
},
"options": {
"polylines": true,
"avoid_tolls": false,
"avoid_highways": true,
"squash_duration": "1.00",
"visit_balance_coefficient": 0
},
"country_id": 1
}{
"auth": true,
"num_late_visits": 0,
"num_unserved": 0,
"solution": {
"99": [
{
"distance": 0,
"finish_time": "08:00",
"location_id": "start_location_50.426195_30.538123",
"arrival_time": "08:00",
"location_name": "start_location_50.426195_30.538123"
},
{
"distance": 7.281,
"finish_time": "08:17",
"location_id": 822,
"arrival_time": "08:13",
"location_name": 822
},
{
"distance": 4.48,
"finish_time": "08:31",
"location_id": 563,
"arrival_time": "08:27",
"location_name": 563
}
],
"111": [
{
"distance": 0,
"finish_time": "13:01",
"location_id": "start_location_50.426195_30.538123",
"arrival_time": "13:01",
"location_name": "start_location_50.426195_30.538123"
},
{
"distance": 2.506,
"finish_time": "13:10",
"location_id": 562,
"arrival_time": "13:06",
"location_name": 562
}
]
},
"status": "success",
"total_break_time": 0,
"total_idle_time": 0,
"total_travel_time": 26,
"total_vehicle_overtime": 0,
"total_visit_lateness": 0,
"total_working_time": 41,
"unserved": null,
"vehicle_overtime": {
"99": 0,
"111": 0
},
"total_distance": 14.267,
"polylines": {
"99": [
"orxd_Bczzfy@sDfEgEbGg@f@_DzEsIzJc`@gaAsDgJSg@{@gJvG_I~a@cj@f@oAf@oA?oA?oASoAS{@g@{@{@Sg@Sg@Rg@Rg@Ro_@rg@wGrIkHfJoAbBcBvBgTrXknAj}AwQnUcVb[_DfEsDzE{EvG{EbGwLzO_InK_{@jiAg@f@gh@fr@gJvL_{@jiAsDzEcBbB_Xr]wB~CwcArtA_DfEcBvBos@zaAcVj\\on@~_AgYbe@g@z@_IjMsDzEg@f@oAz@cBz@wBz@{J~CcLfEkCvL{@jCoArDg^zr@_InPg^bt@gEnFkCjC{EjC_DnA{Ez@{JbBg@RgEf@gJbB_NvBwVrD_Df@_DRwBRgEf@{Ef@kHz@oARcBnAcBbBwBfEcBzEg@nF_D~a@g@nFwBjRg@bBg@vBg@bB{@vBoPsDsXwG_v@cQsDSwBRg@?S?SRSRSRg@RSf@Sf@{@vL{E~f@cBzTsNr~Ag@rD?f@{@~HcBrS{Ebj@cBvQsD~a@oAjMwVrpC{@zJ{@fJ_Dn_@oFnn@SbBkCzYSjCS~C_Iv~@SnAgEfc@kHfw@g@nFg@zE?nAgJ~dASnASjCoAvLg@jHcBfOsD~a@gErb@oF~k@cG~p@g@zEg@bGcBfTc[fjDg@~C?nAcLnlAoAzOSvBsD~a@SnAg@~CcBrD{@f@oAf@_Df@sIrIoFnFsDfEoAz@sIzJoAz@wGjHcBbBkCjC{JnKkC~CsXfYsDrDoFvGo_@v`@cQvQsIrI{EnFkR~RcQvQ{JnK{EnF{m@bo@sDz@_Dg@sX_I_]wLoU{J_SkHsN{E_NgEcBg@cVg@oPS_D?{@SRrI?rNRb[f@bQf@jf@?nFRj\\Rz^RzJ?zORnUS~HSvGg@~CoAvGg@z@Sz@sXfw@cBrDkH~RwBnF_I~RoA~CsDnK_IbQcGnKgJnKgEzEcGbGkWvVsNrNwBvBoFfEwBvBgOfOSf@gc@nd@oKnKwQrSoPsl@cVs{@Sg@SkCg@?{@?{@RsD{@gaAkMoA?wQnAcBRg^zJw[nKoKrD_Dz@{J~CoAf@{TrDwQjCkHRoPR?oAf@{^RcLnAgkA_q@_D{J{@{ErDwLnA_SgE{@g@z@f@~RfEvLoAzEsDzJz@~p@~CoAfkASbLg@z^?nAnPSjHSvQkCzTsDnAg@zJ_D~C{@nKsDv[oKf^{JbBSvQoAnA?faAjMrDz@z@Sz@?f@??oZSwhA?sD?cG?kCg@wBg@wBg@cBS{@cBcB_D_DsjAc~@oAwBg@cBg@wBg@cGg@gJg@sSS_IS{ToAchASwLcBolAg@wV?sI?sIf@cGnAsIbBkHf@cBvBcLjHkWfEgOnAgEz@{Ef@gERoF?gToAwt@SwLg@sX{@kk@?wBg@cV{@s]g@{OSkMS{Eg@sl@g@sIoA{JwBsIsIc[cB{E{@_DgE{OsDoP_DoPkCgOkCoPsDgYcBsSg@wLSkHR_IRkHf@wGz@{ErDoPrNgm@vBgJz@gJbGcLRSsNkWcBsD{c@cy@gTg^gY_g@cGcL{@wBcB_D_I{Og@{@sIgO{JwQcB_DcB_DsDnFsDjHoAbB{@nAoAjCoAvBkHfO{h@~dAg@fEg@nAsIzOoAjCgc@fw@_DbGg@nAcBg@{To_@g@oAoAwBwBgEkf@{|@g@cBcB_DoAwBoAcBkCnFg^bo@oKrS{EzJcB~CwBrDsNzY{@bBoFfJ{Yjk@kCnFkHjMwe@f|@cBrDwBfEc`@bt@gOzYg@nA{@nAg@z@{@bB_IzO_DvGoFfJgE~HkWjf@_Nb[cLnUoK~R_IrNoKrSwGvLvB~CvBvGja@jp@zERfTr]~CcBbQnZoFvL"
],
"111": [
"orxd_Bczzfy@sDfEgEbGg@f@_DzEsIzJc`@gaAsDgJSg@{@gJvG_I~a@cj@jHsIjHgJzOsS~CgEni@os@v[w`@~CsDnFwG~H_IrIkHnP{Jve@gYnKwGzEkCjHoFzEwGbGkH~W{^rDoF~CrIjHvQvVnn@jCzEvB~CvB~CvVvVnKnKzTbVv[~\\jk@rl@jCjCfYzYzEnFjR~RrD~CRrIsNj_A{Jbo@{@jHsIzh@_Ifh@{@bGoAbGSbBoPzfA{@bGgOr`AwBvLoAfJcBbLoFv[_I~f@oAbLg@jCcGja@sI_D_v@oPkC{@gJwBoPsDsDwBsg@{YwB{@_SgOkCoA{c@_IcBg@fE{O"
]
}
}