Skip to content

Products

Info

Please find the product definition of the flinkey Box here and of the flinkey IQ there.

Get products

GET /products

Tip

The returned data can be manipulated using OData.

Request parameters
Name Type Location Description
flinkey-API-Key string header Required. API key which provides access to this API.
Authorization string header Required. The bearer token.
Customer-ID integer header Required. The database ID of the customer.
Response
200 OK
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "format": "int32"
      },
      "uniqueId": {
        "type": "string"
      },
      "serialNumber": {
        "type": "string"
      },
      "sapNumber": {
        "type": "string"
      },
      "dongleTerminationTimeStamp": {
        "type": [
          "string",
          "null"
        ],
        "format": "date-time"
      },
      "type": {
        "type": "string",
        "enum": [
          "flinkey Box",
          "flinkey IQ"
        ]
      }
    }
  }
}
Response
401 UNAUTHORIZED

{
  "statusCode": 401,
  "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}
{
  "statusCode": 401,
  "message": "Unauthorized. Access token is missing or invalid."
}
Response
404 NOT FOUND
Unable to find a manager for the given OAuth ID claim data.
Response
500 INTERNAL SERVER ERROR
Internal server error.

Get product

GET /products/{productId}

Tip

The returned data can be manipulated using OData.

Request parameters
Name Type Location Description
flinkey-API-Key string header Required. API key which provides access to this API.
Authorization string header Required. The bearer token.
Customer-ID integer header Required. The database ID of the customer.
productId integer path Required. The database ID of the product.
Response
200 OK
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "format": "int32"
    },
    "uniqueId": {
      "type": "string"
    },
    "serialNumber": {
      "type": "string"
    },
    "sapNumber": {
      "type": "string"
    },
    "dongleTerminationTimeStamp": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "type": {
      "type": "string",
      "enum": [
        "flinkey Box",
        "flinkey IQ"
      ]
    }
  }
}
Response
401 UNAUTHORIZED

{
  "statusCode": 401,
  "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}
{
  "statusCode": 401,
  "message": "Unauthorized. Access token is missing or invalid."
}
Response
404 NOT FOUND
Unable to find a manager for the given OAuth ID claim data.
Unable to find a product for the given productId which is assigned to the given customerId.
Response
500 INTERNAL SERVER ERROR
Internal server error.

Get service of product

GET /products/{productId}/services

Tip

The returned data can be manipulated using OData.

Request parameters
Name Type Location Description
flinkey-API-Key string header Required. API key which provides access to this API.
Authorization string header Required. The bearer token.
Customer-ID integer header Required. The database ID of the customer.
productId integer path Required. The database ID of the product.
Response
200 OK
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "format": "int32"
    },
    "name": {
      "type": "string"
    },
    "isTerminated": {
      "type": "boolean"
    },
    "terminationDate": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    },
    "terminationCause": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}
Response
401 UNAUTHORIZED

{
  "statusCode": 401,
  "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}
{
  "statusCode": 401,
  "message": "Unauthorized. Access token is missing or invalid."
}
Response
404 NOT FOUND
Unable to find a manager for the given OAuth ID claim data.
No product can be found for this productId that is assigned to this customerId.
No service can be found that is assigned to this productId.
Response
500 INTERNAL SERVER ERROR
Internal server error.

Get car of product

GET /products/{productId}/cars

Tip

The returned data can be manipulated using OData.

Request parameters
Name Type Location Description
flinkey-API-Key string header Required. API key which provides access to this API.
Authorization string header Required. The bearer token.
Customer-ID integer header Required. The database ID of the customer.
productId integer path Required. The database ID of the product.
Response
200 OK
{
  "type": "object",
  "properties": {
    "id": {
      "type": "number",
      "format": "int32"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "vin": {
      "type": [
        "string",
        "null"
      ]
    },
    "licensePlate": {
      "type": [
        "string",
        "null"
      ]
    },
    "brand": {
      "type": [
        "string",
        "null"
      ]
    },
    "model": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}
Response
401 UNAUTHORIZED

{
  "statusCode": 401,
  "message": "Access denied due to invalid subscription key. Make sure to provide a valid key for an active subscription."
}
{
  "statusCode": 401,
  "message": "Unauthorized. Access token is missing or invalid."
}
Response
404 NOT FOUND
Unable to find a manager for the given OAuth ID claim data.
No product can be found for this productId that is assigned to this customerId.
No car can be found that is assigned to this productId.
Response
500 INTERNAL SERVER ERROR
Internal server error.