NAV

Introduction

Welcome to ITC API.

The following documentation should help you make use of our API service.

If you experience any issues, please contact support.

Authentication

In order to use the API, you should authenticate your request by including your API key as a bearer token value.

Authorization: Bearer API_KEY_HERE

Headers

Make sure to include the following headers in each request.

Accept: application/json Content-Type: application/json

URI

ITC API is hosted on the following base url.

https://itc-api.rossquigley.co.uk

API Version

All HTTP Requests within this documentation refer to our latest (stable) API.

/api/v1

Errors

ITC API uses the following error codes:

Error Code Meaning
200 Everything is ok.
400 Valid data was given but the request has failed.
401 No valid API Key was given.
404 The request resource could not be found.
422 The payload has missing required parameters or invalid data was given.
429 Too many attempts.
500 Request failed due to an internal error in ITC API.
503 ITC API is offline for maintenance.

Products

All Products

Return all products listed within account.

Response

[
    {
        "id": 1,
        "name": "Combined GAP",
        "slug": "combgap",
        "description": "Combines the benefits of Total Loss and Finance GAP which pays the higher of the invoice value or the finance settlement figure when a vehicle is deemed a total loss",
        "created_at": "2021-03-12T10:50:30.000000Z",
        "updated_at": "2021-03-12T12:16:16.000000Z",
        "type": {
            "id": 1,
            "name": "motor",
            "slug": "motor",
            "created_at": "2021-03-12T11:03:05.000000Z",
            "updated_at": "2021-03-12T11:03:05.000000Z"
        },
        "suppliers": [
            {
                "id": 1,
                "name": "Vehicle Protect UK",
                "slug": "vehicle-protect-uk",
                "created_at": "2021-03-12T11:03:05.000000Z",
                "updated_at": "2021-03-12T11:03:05.000000Z"
            },
            {
                "id": 2,
                "name": "EM GAP Insurance",
                "slug": "em-gap-insurance",
                "created_at": "2021-03-12T11:03:05.000000Z",
                "updated_at": "2021-03-12T11:03:05.000000Z"
            }
        ]
    },
    {
        "id": 2,
        "name": "SMART",
        "slug": "smart",
        "description": "Pays for repairs to minor or cosmetic damage to your vehicle",
        "created_at": "2021-03-12T10:50:31.000000Z",
        "updated_at": "2021-03-12T12:16:16.000000Z",
        "type": {
            "id": 1,
            "name": "motor",
            "slug": "motor",
            "created_at": "2021-03-12T11:03:05.000000Z",
            "updated_at": "2021-03-12T11:03:05.000000Z"
        },
        "suppliers": [
            {
                "id": 1,
                "name": "Vehicle Protect UK",
                "slug": "vehicle-protect-uk",
                "created_at": "2021-03-12T11:03:05.000000Z",
                "updated_at": "2021-03-12T11:03:05.000000Z"
            }
        ]
    }
]

HTTP Request

GET /api/v1/products

Get A Product

Return a product listed within account.

Response

[
    {
        "id": 1,
        "name": "Combined GAP",
        "slug": "combgap",
        "description": "Combines the benefits of Total Loss and Finance GAP which pays the higher of the invoice value or the finance settlement figure when a vehicle is deemed a total loss",
        "created_at": "2021-03-12T10:50:30.000000Z",
        "updated_at": "2021-03-12T12:16:16.000000Z",
        "type": {
            "id": 1,
            "name": "motor",
            "slug": "motor",
            "created_at": "2021-03-12T11:03:05.000000Z",
            "updated_at": "2021-03-12T11:03:05.000000Z"
        },
        "suppliers": [
            {
                "id": 1,
                "name": "Vehicle Protect UK",
                "slug": "vehicle-protect-uk",
                "created_at": "2021-03-12T11:03:05.000000Z",
                "updated_at": "2021-03-12T11:03:05.000000Z"
            },
            {
                "id": 2,
                "name": "EM GAP Insurance",
                "slug": "em-gap-insurance",
                "created_at": "2021-03-12T11:03:05.000000Z",
                "updated_at": "2021-03-12T11:03:05.000000Z"
            }
        ]
    }
]

HTTP Request

GET /api/v1/products/{id}

Suppliers

All Suppliers

Return all suppliers listed within account.

Response

[
    {
        "id": 1,
        "name": "Vehicle Protect UK",
        "slug": "vehicle-protect-uk",
        "created_at": "2021-03-12T11:03:05.000000Z",
        "updated_at": "2021-03-12T11:03:05.000000Z"
    },
    {
        "id": 2,
        "name": "EM GAP Insurance",
        "slug": "em-gap-insurance",
        "created_at": "2021-03-12T11:03:05.000000Z",
        "updated_at": "2021-03-12T11:03:05.000000Z"
    }
]

HTTP Request

GET /api/v1/suppliers

Get A Supplier

Return a supplier listed within account.

Response

{
    "id": 1,
    "name": "Vehicle Protect UK",
    "slug": "vehicle-protect-uk",
    "created_at": "2021-03-12T11:03:05.000000Z",
    "updated_at": "2021-03-12T11:03:05.000000Z"
}

HTTP Request

GET /api/v1/suppliers/{id}

Types

All Types

Return all types listed within account.

Response

[
    {
        "id": 1,
        "name": "motor",
        "slug": "motor",
        "created_at": "2021-03-12T11:03:05.000000Z",
        "updated_at": "2021-03-12T11:03:05.000000Z"
    },
    {
        "id": 2,
        "name": "travel",
        "slug": "travel",
        "created_at": "2021-03-12T11:03:05.000000Z",
        "updated_at": "2021-03-12T11:03:05.000000Z"
    }
]

HTTP Request

GET /api/v1/types

Get A Type

Return a type listed within account.

Response

{
    "id": 1,
    "name": "motor",
    "slug": "motor",
    "created_at": "2021-03-12T11:03:05.000000Z",
    "updated_at": "2021-03-12T11:03:05.000000Z"
}

HTTP Request

GET /api/v1/types/{id}