API Integration for Fleet Owner¶

This tutorial will guide you through process of integrating with Dook delivery services.

Contents:

Loggin In¶

To make any operations using Dook RESTfull APIs, you need to be logged in. To log into Dook, you need to specify your user credentials in the POST request:

POST URL/api/Auths/login¶

Parameters

Parameter	Type	Value
{email}	`string`	Your e-mail used at registration step
{password}	`string`	Your password used at registration step

JSON Request Example¶

{
    "email":"email@example.com  ",
    "password":"password_example"
}

JSON Response Example¶

{
    "id": string,
    "ttl": number,
    "created": datastring,
    "userId": string,
    "language": string,
    "role": string,
    "companyId": string
}

Where

{id} - your authorization token

{ttl} - time-to-live

{created} - date and time the session was created

{userId} - user’s 24-digit hash

Creating Teams¶

To create a team and unite operators, drivers, or dispatchers into a team, use the following request:

POST URL/Companies/<companyId>/teams?access_token=<your_access_token>¶

NOTE: to create a team, you must be authorized. For info on getting your authorization token, refer to Loggin In.

Parameters

Parameter	Type	Value
{name}	`string`	Name of the team
{autoAssign}	`boolean`	Specify true/false to enable or disable automatic assignin of orders for the team.
{cityId}	`string`	Specify id of the city in which the team resides.

NOTE: to get the list of countries and cities, refer to Getting City and Country IDs.

JSON Request Example¶

{
            "name": "string",
            "autoAssign": false,
            "cityId": "string"
}

JSON Response Example¶

{
            "name": string,
            "autoAssign": boolean,
            "id": string,
            "companyId": string,
            "cityId": string,
            "createdAt": datastring,
            "updatedAt": datastring
}

Querying Team IDs¶

To get team IDs, use the following method:

POST URL/api/Companies/<company_id>/teams¶

NOTE: to get teams, you must be authorized. For info on getting your authorization token, refer to Loggin In.

Parameters

Parameter	Type	Value
{id}	`string`	ID of the team

JSON Response Example¶

{
    "name": "string 123",
    "autoAssign": false,
    "id": "5942b49642267d0f00bef7aa",
    "companyId": "590397f11779a4dc53ef9258",
    "cityId": "5905ca988b076b0f0084bd10",
    "createdAt": "2017-06-15T16:23:50.627Z",
    "updatedAt": "2017-06-15T16:23:50.628Z"
}

Removing Teams¶

To remove a team, use the following request:

DELETE URL/api/Teams/<team_id>?access_token=<your_access_token>¶

NOTE: to remove a team, you must be authorized. For info on getting your authorization token, refer to Loggin In.

JSON Response Example¶

    {
            "count": N // N is the number of teams that have been removed
    }

Creating Pickup Point for Team¶

To create a pickup point for your teams, use the following method:

POST URL/api/PickUpPoints?access_token=<your_access_token>¶

NOTE: to create an operator, you must be authorized. For info on getting your authorization token, refer to Loggin In.

Parameters

Parameter	Type	Value
{address}	`string`	Address of the pickup point
{gpsLocation}	`object`	Delivery GPS coordinates `"lat"`: `xx.xxxxxxxxxxxxxxx,` `"lng"`: `xx.xxxxxxxxxxxxxxx,`
{title}	`string`	Name of the pickup point
{contactName}	`string`	Name of the pickup point’s contact person
{phone}	`string`	Contact phone of the pickup point
{teamId}	`string`	Id of the team

NOTE: to get team IDs, you must query the teams, for details refer to Querying Team IDs.

JSON Request Example¶

{
    "address": "string",
    "gpsLocation": {
        "lat": 0,
        "lng": 0
    },
    "title": "string",
    "contactName": "string",
    "phone": "string",
    "teamId": "string"
}

JSON Response Example¶

{
    "address": string,
    "gpsLocation": {
            "lat": 0,
            "lng": 0
    },
    "title": string,
    "contactName": string,
    "phone": string,
    "id": string,
    "createdAt": string,
    "updatedAt": string,
    "companyId": string,
    "teamId": string
}

Removing Pickup Points¶

To delete a pickup point,

DELETE URL/api/PickUpPoints/<pickUpPointId>?access_token=<your_access_token>¶

NOTE: to delete a pickup point, you must be authorized. For info on getting your authorization token, refer to Loggin In.

Parameters

Parameter	Type	Value
{id}	`string`	ID of the pickup point

JSON Request Example¶

{
    "id": "string"
}

JSON Response Example¶

{
    "count": number
}

Querying Team Members¶

This API enables you to get members of a particular team.