Planner's API will allow you to create and obtain information through a RESTful protocol. The lite version of the API will allow you to make 1,000 requests per day without having to pay for the use of the API. In case you need an upgrade please write us to support@dispatchtrack.com.
\nThis page shows in detail the steps needed for integrating with Planner though an HTTP webservice using a JSON format. If you need help please contact us at support@dispatchtrack.com.
\nHeaders must be set in order to authenticate and link the information to your account. Planner API requires the following headers:
\n'Content-Type:application/json'.Example:
\n"Authorization": "Basic cGxhbm5lcl8wMTp6bXpzV20xWm5ldkpIN21KdVVXRXNXRkVlUGRRU3hjQTZxK3dZeFdtVzJNeFdzTUh3UGZ3cWJoYzRXZURKQmtEa1pSMzNhQVR2NCs5bVAramJGYW1NUWxTTGV3Y2o4djYvY0E9LS1RZk9pUTF3b0ROWXhqUnJFLS1ZdHg5Vnl3TFpzS2d4Lzc5eTdjMXB3PT0="\n"Content-Type": "application/json"\nBy default, the API has limits to prevent an overload of Planner service. Please design your solution to comply with the following limits:
\nWe accept filters parameters to search and object's group or some specific one. Also, can mix the filters for a more bounded search
\nExample:
\n"filters": { "created_at": 2019/12/12 }\n"filters": { "created_at_lt": 2019/12/12 }\n"filters": { "created_at_lteq": 2019/12/12 }\n"filters": { "created_at_gt": 2019/12/12 }\n"filters": { "created_at_gteq": 2019/12/12 }\n"filters": { "created_at_lteq": 2019/12/12, "created_at_gteq": 2019/12/10 }\n"filters": { "created_at_lt": 2019/12/12, "created_at_gteq": 2019/12/10 }\n"filters": { "created_at_lteq": 2019/12/12, "created_at_gt": 2019/12/10 }\nEvery Index endpoint is paginated by 30 resources per request. You can set the page and the quantity per page to get in every request, max resources per page is 100.
\nExample:
\n"page: 3"\n"per_page: 20"\nEvery Index response have meta information: pages with the total number of elements, pages, current page and resources per page; links with the urls to go first, next, prev and last page for that resource.
\n"meta": {\n "pages": {\n "total_pages": 1,\n "total_elements": 2,\n "current_page": 1,\n "objects_per_page": 30\n },\n "links": {\n "first": "http://test.host/external_api/v1/places?page=1",\n "last": "http://test.host/external_api/v1/places?page=1",\n "prev": "http://test.host/external_api/v1/places?page=1",\n "next": "http://test.host/external_api/v1/places"\n }\n}\nWhen some resource was unsuccessfully created, the errors will show in the following way:
\nExample
\n"errors"=>\n [\n {\n\t "entity"=>"items[1]",\n\t "name"=>"Item's name can't be blank"\n }\n ]\nArray's number start at 0.
\nFailure to comply with these limits may result in denial of services due to a "To Many Requests" error. If you need to increase this limits, please contact support@dispatchtrack.com.
\nPlanner Webhooks are the recommended way of keeping your system up to date with planned routes from Dispatchtrack. In order to add a webhook endpoint, you must register a custom URL into which will be used for all webhooks. Custom headers can also be added. In case you need an upgrade please write us to support@dispatchtrack.com. For the wehbook payload, please use the parameters specification on each webhook's section.
\nTo create and activate webhooks check our support center
\nHeaders must be set in order to authenticate with your services. Example:
\n{ \"Content-Type\": \"application/json\", \"X-AUTH-TOKEN\": \"18cf703857db062a72422e5c7134272e\"}\n\nCalled when a plan is exported. Endpoint will receive 1 POST request per each route created from the exported plan.
\nhttp(s)://custom_url_client/\n\n
Example JSON
\n{\n\t\"plan_id\": 147,\n\t\"route_id\": 1117,\n\t\"account_id\": 3,\n\t\"user_id\": 3,\n\t\"start_date\": \"2020-03-20\",\n\t\"end_date\": \"2020-03-20\",\n\t\"start_time\": 28800,\n\t\"end_time\": 61159,\n\t\"vehicle\": {\n\t\t\"identifier\": \"ABC-001\"\n\t},\n\t\"stops\": [{\n\t\t\"stop_group_id\": 180,\n\t\t\"stop_id\": 26971,\n\t\t\"identifier\": \"5351907335\",\n\t\t\"latitude\": -33.42341,\n\t\t\"longitude\": -70.64042,\n\t\t\"address\": \"Test avenue 854\",\n\t\t\"arrival_time\": 30720,\n\t\t\"driving_period\": 1920,\n\t\t\"service_time\": 600,\n\t\t\"delivery_times\": [{\n\t\t\t\"min_delivery_time\": \"2020-03-20 11:00:00 UTC\",\n\t\t\t\"max_delivery_time\": \"2020-03-20 20:00:00 UTC\"\n\t\t}]\n\t}]\n}\n\nField Description
\n1. Route attributes
\n| Field | \nType | \nDescription | \n
|---|---|---|
| plan_id | \nInteger | \nPlan unique ID | \n
| route_id | \nInteger | \nRoute unique ID | \n
| account_id | \nInteger | \nDispatchtrack's account unique ID | \n
| user_id | \nInteger | \nUser who exports plan unique ID | \n
| start_date | \nString | \nDate with format ISO8601 Y-M-D | \n
| end_date | \nString | \nDate with format ISO8601 Y-M-D | \n
| start_time | \nInteger | \nRoute start time in seconds since beginning of day | \n
| end_time | \nInteger | \nRoute end time in seconds since beginning of day | \n
2. Vehicle attributes
\n| Field | \nType | \nDescription | \n
|---|---|---|
| identifier | \nString | \nVehicle identifier | \n
3. Stops attributes
\n| Field | \nType | \nDescription | \n
|---|---|---|
| stop_group_id | \nInteger | \nStop group identifier | \n
| stop_id | \nInteger | \nStop unique ID | \n
| identifier | \nString | \nStop identifier | \n
| latitude | \nFloat | \nStop latitude | \n
| longitude | \nFloat | \nStop longitude | \n
| address | \nString | \nStop address | \n
| arrival_time | \nInteger | \nStop arrival time in seconds since beginning of day | \n
| driving_period | \nInteger | \nDriving period to stop in seconds | \n
| service_time | \nInteger | \nStop service time in seconds | \n
3. Delivery times
\n| Field | \nType | \nDescription | \n
|---|---|---|
| min_delivery_time | \nString | \nDate with format ISO8601 Y-M-D H:M:S in UTC | \n
| max_delivery_time | \nString | \nDate with format ISO8601 Y-M-D H:M:S in UTC | \n