• API Spécifications

    Introduction

     

    Account

    create.v1

     

    User

    checkToken.v1

    getTokenByCredentials.v1

    resetPassword.v1

     

    Assets

    getList.v1

    getInfo.v1

    getHealth.v1

    getPosition.v1

    getOverview.v1

     

    Trackers

    getList.v1

    getInfo.v1

     

    Trips

    getList.v1

    getInfo.v1

    getSummary.v1

     

    Fuel

    getSummary.v1

     

    Eco

    getSummary.v1

     

    Maintenance

    getList.v1

    getSummary.v1

     

    Insurance

    getList.v1

    getAll.v1

    getExpiring.v1

     

    Introduction

    API endpoint: https://api.carfics.com

    Version: 1

    URL: https://api.carfics.com/{version}/{section}/{method}/

    Example: https://api.carfics.com/v1/user/checkToken/

     

    account / create (v1)

    Request URL: https://api.carfics.com/v1/account/create/

    Request

     

    POST /api/v1/account/create/ HTTP/1.1

    Host: api.carfics.com

    Content-Type: application/json; charset=utf-8;

     

    {

    "name": "John Doe",

    "email": "[email protected]",

    "password": "123456",

    "timezone": "Europe\/Paris",

    "language": "fr"

    }

     

    Response

    {

    "success": true,

    "data": {

    "token": "51910bfe-26c3-3468fa38-1d05-5c6d270e"

        }

    }

    List error and description

     

    INVALID_EMAIL = Invalid email format

    INVALID_NAME = Blank / Incorrect name

    WEAK_PASSWORD = Password length is less than 6 symbols

    USER_EXISTS = User with such email already exists

    TECHNICAL_ERROR = Unexpected exception

    user / checkToken (v1)

    Request URL: https://api.carfics.com/v1/user/checkToken/

    Request

     

    POST /api/v1/user/checkToken/ HTTP/1.1

    Host: api.carfics.com

    Content-Type: application/json; charset=utf-8;

    {

    "email": "[email protected]",

        "token": "effe4643-4126-2a14-9ebd-1452131e4197"

    }

     

    Response 

     

    {

    "success": true,

    "data": {

    "isValid": true

    }

    }

    List error and description

     

    INVALID_EMAIL = Invalid email format

    NO_SUCH_USER = No user with such email found

    user / getTokenByCredentials (v1)

    Request URL: https://api.carfics.com/v1/user/getTokenByCredentials/

    Request

     

    POST /api/v1/user/getTokenByCredentials/ HTTP/1.1

    Host: api.carfics.com

    Content-Type: application/json; charset=utf-8;

    {

       "email": "[email protected]",

      "password": "123456789"

    }

     

    Response   

     

    {

    "success": true,

    "data": {

    "token": "effe4643-4126-2a14-9ebd-1452131e4197"

        }

    }

    List error and description

    INVALID_EMAIL = Invalid email format

    NO_SUCH_USER = No user with such email found

    AUTH_FAILED = Login information is incorrect (e-mail/password do not match)

    user / resetPassword (v1)

    Request URL: https://api.carfics.com/v1/user/resetPassword/

    Request

     

    POST /api/v1/user/resetPassword/ HTTP/1.1

    Host: api.carfics.com

    Content-Type: application/json; charset=utf-8;

    {

    "email": "[email protected]"

    }

     

    Response   

     

    {

    "success": true,

        "data": []

    }

    List error and description

    INVALID_EMAIL = Invalid email format

    NO_SUCH_USER = No user with such email found

    assets / getList (v1)

    Request URL: https://api.carfics.com/v1/assets/getList/

    Request

    POST /api/v1/assets/getList/ HTTP/1.1

    Host: app.wisetrace.com

    Content-Type: application/json; charset=utf-8;

    {

    "token": "token"

    }

     

    Response

    {

    "success": true,

    "data": [

    {

    "assetId": 1,

    "assetType": "vehicle",

    "name": "BMW X5",

    "plateNumber": "731 KSP",

    "manufacturer": "BMW",

    "model": "X5",

    "year": 2014,

    "driver": {

    "isKnown": true,

    "id": 1,

    "name": "John Doe"

    },

    "mileage": 100281.51,

    "position": {

    "latitude": 59.43098,

    "longitude": 24.737289,

    "direction": 121,

    "numOfSatellites": 12,

    "speed": 32.9,

    "dateUpdated": "2017-08-29 17:10:00"

    },

    "state": "VEHICLE_MOVING|VEHICLE_PARKED|VEHICLE_PARKED_AGO|VEHICLE_LOST_SIGNAL|VEHICLE_LOST_SIGNAL_AGO|VEHICLE_OFFLINE|VEHICLE_DISCONNECTED",

    "formatted": "32.9 km\/h",

    "voltageBattery": "12.1 V",

    "hasWarnings": false

    },

    {

    "assetId": 1,

    "assetType": "device",

    "name": "Mobile tracker 1",

    "manufacturer": "Samsung",

    "model": "A5",

    "user": {

    "isKnown": true,

    "id": 1,

    "name": "John Doe"

    },

    "position": {

    "latitude": 59.43098,

    "longitude": 24.737289,

    "direction": 121,

    "numOfSatellites": 12,

    "dateUpdated": "2017-08-29 17:10:00"

    },

    "state": "MOBILE_LOCATED|MOBILE_LOCATED_AGO|MOBILE_OFFLINE",

    "formatted": "3 min ago",

    "voltageBattery": "12.1 V",

    "hasWarnings": false

    }

    ]

    }

    List error and description

    INVALID_TOKEN = Invalid token

    assets / getInfo (v1)

    Request URL: https://api.carfics.com/v1/assets/getInfo/

    Request

    POST /api/v1/assets/getInfo/ HTTP/1.1

    Host: api.carfics.com

    Content-Type: application/json; charset=utf-8;

     

    {

    "token": "token",

    "assetId": 1

    }

     

    Response

    {

    "success": true,

    "data": []

    }

    List error and description

    INVALID_TOKEN = Invalid token

    INVALID_ASSET_ID = Invalid asset id

    assets / getHealth (v1)

    Request URL: https://api.carfics.com/v1/assets/getHealth/

    Request

     

    POST /api/v1/assets/getHealth/ HTTP/1.1

    Host: api.carfics.com

    Content-Type: application/json; charset=utf-8;

     

    {

    "token": "token",

    "assetId": 1

    }

     

    Response

    {

    "success": true,

    "data": []

    }

     

    List error and description

    INVALID_TOKEN = Invalid token

    INVALID_ASSET_ID = Invalid asset id

    assets / getPosition (v1)

    Request URL: https://api.carfics.com/v1/assets/getPosition/

    Request

     

    POST /api/v1/assets/getPosition/ HTTP/1.1

    Host: api.carfics.com

    Content-Type: application/json; charset=utf-8;

     

    {

    "token": "token",

    "assetId": 1,

    "numOfPoints": 2

    }

     

    Response

    {

    "success": true,

    "data": {

    "points": [

    {

    "pointId": 2505238,

    "latitude": 59.4524249,

    "longitude": 24.8716816,

    "direction": 0,

    "numOfSatellites": 0,

    "speed": 0,

    "voltageBattery": 12.826,

    "dateUpdated": "2017-12-25 08:10:29"

    },

    {

    "pointId": 2505228,

    "latitude": 59.4524249,

    "longitude": 24.8716816,

    "direction": 251,

    "numOfSatellites": 19,

    "speed": 0,

    "voltageBattery": 12.793,

    "dateUpdated": "2017-12-25 06:10:29"

    }

    ],

    "state": "VEHICLE_PARKED_AGO",

    "formatted": "3 h"

    }

    }

     

    List error and description

    INVALID_TOKEN = Invalid token

    INVALID_ASSET_ID = Invalid asset id

    NO_DATA = No data available

    assets / getOverview (v1)

    Request URL: https://api.carfics.com/v1/assets/getOverview/