Skip to content

Keyfob

Info

Please find the Keyfob definition here.

Get brands

GET /brands

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.
Response
200 OK

{
  "type": "array",
  "items": {
    "type": "string"
  }
}
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
500 INTERNAL SERVER ERROR

Internal server error.

Get keys of brand

GET /brands/{brand}/keys

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.
brand string path Required. The bearer token.
Response
200 OK

{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "number",
        "format": "int32"
      },
      "brand": {
        "type": "string"
      },
      "boxName": {
        "type": [
          "string",
          "null"
        ]
      },
      "boxSapNumber": {
        "type": [
          "string",
          "null"
        ]
      },
      "keyForm": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "format": "int32"
          },
          "name": {
            "type": "string"
          },
          "imageUrl": {
            "type": "string"
          }
        }
      }
    }
  }
}
Response
400 BAD REQUEST

Invalid brand provided.
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 the given brand. Invalid brand provided.
Response
500 INTERNAL SERVER ERROR

Internal server error.