doc_tap_cloudapi_first;

doc_tap_if_interested; Integration Protocol (AMX, Lutron, Crestron, Control4, Clipsal)

doc_tap_what_is;

doc_tap_what_is_cloudapi_first;

doc_tap_what_is_cloudapi_second;

doc_tap_what_is_cloudapi_local;

doc_tap_authenticating;

doc_tap_authenticating_first;

doc_tap_authenticating_second;

Authorization: TapHome {token}

doc_tap_authenticating_third;

GET /api/TapHomeApi/v1/location HTTP/1.1
Host: api.taphome.com
Authorization: TapHome 6d9b653d-9e07-4cf0-94a8-a51fc023ea32

doc_tap_authenticating_fourth;

curl -X GET -H "Authorization: TapHome 6d9b653d-9e07-4cf0-94a8-a51fc023ea32" "https://api.taphome.com/api/TapHomeApi/v1/location"

doc_tap_authenticating_fifth;

doc_tap_how_to_token;

doc_tap_how_to_token_all;

doc_tap_cludapi_reference;

doc_tap_get_location_info;

doc_tap_unit_location_info;

Variant 1
GET /api/TapHomeApi/v1/location

doc_tap_paramteres;

Variant 2
POST /api/TapHomeApi/v1/location

doc_tap_parameters_response;

{
  "locationId": "53e14fbd-c9d1-4615-b994-8d6ec8834e7b",
  "locationName": "Test Location",
  "timestamp": 855000000000
}

doc_tap_possible_errors;

doc_tap_discover_devices;

doc_tap_discover_devices_pokus;

Variant 1
GET /api/TapHomeApi/v1/discovery

doc_tap_discover_devices_parameters;

Variant 2
POST /api/TapHomeApi/v1/discovery

doc_tap_parameters_example;

{
  "devices": [
    {
      "deviceId": 1,
      "type": "VirtualAnalogOutput",
      "name": "My AO",
      "description": "My AO Description",
      "supportedValues": [
        {
          "valueTypeId": 7,
          "valueTypeName": "DeviceStatus"
        },
        {
          "valueTypeId": 42,
          "valueTypeName": "AnalogOutputValue"
        },
        {
          "valueTypeId": 48,
          "valueTypeName": "SwitchState"
        },
        {
          "valueTypeId": 67,
          "valueTypeName": "AnalogOutputDesiredValue"
        }
      ]
    },
    {
      "deviceId": 2,
      "type": "VirtualBlindGroup",
      "name": "My Blind Group",
      "description": "My Blind Group Description",
      "supportedValues": [
        {
          "valueTypeId": 7,
          "valueTypeName": "DeviceStatus"
        },
        {
          "valueTypeId": 10,
          "valueTypeName": "BlindsSlope"
        },
        {
          "valueTypeId": 46,
          "valueTypeName": "BlindsLevel"
        }
      ]
    }
  ],
  "timestamp": 855000000000
}

doc_tap_http_status_errors;

doc_tap_get_device_value;

doc_tap_value_text_one;

doc_tap_value_text_two;

doc_tap_value_text_three;

Variant 1
GET /api/CloudApi/v1/getDeviceValue/{deviceId}

doc_tap_variants_parameters;

Variant 2
POST /api/CloudApi/v1/getDeviceValue

doc_tap_paramteres_xy;

{
  "deviceId": 1
}

doc_tap_example_response;

{
  "deviceId": 1,
  "values": [
    {
      "valueTypeId": 7,
      "valueTypeName": "DeviceStatus",
      "value": 0
    },
    {
      "valueTypeId": 22,
      "valueTypeName": "OperationMode",
      "value": 0
    },
    {
      "valueTypeId": 23,
      "valueTypeName": "ManualTimeout",
      "value": 0
    },
    {
      "valueTypeId": 42,
      "valueTypeName": "AnalogOutputValue",
      "value": 1
    },
    {
      "valueTypeId": 48,
      "valueTypeName": "SwitchState",
      "value": 1
    },
    {
      "valueTypeId": 67,
      "valueTypeName": "AnalogOutputDesiredValue",
      "value": 1
    }
  ],
  "timestamp": 855000000000
}

doc_tap_errors_three;

doc_tap_get_multipledevices_values;

doc_tap_get_multipledevices_values_text;

doc_tap_get_savebandwidth;

POST /api/CloudApi/v1/getMultipleDevicesValues

doc_tap_paramteres_xy;

{
 "devices": [
    {
      "deviceId": 1,
      "valueTypeId": 7
    },
    {
      "deviceId": 2
    }
  ],
  "timestamp": 855000000000
}

doc_tap_example_response;

{
 "devices": [
    {
      "deviceId": 1,
      "values": [
        {
          "valueTypeId": 7,
          "valueTypeName": "DeviceStatus",
          "value": 0
        }
      ]
    },
    {
      "deviceId": 2,
      "values": [
        {
          "valueTypeId": 7,
          "valueTypeName": "DeviceStatus",
          "value": 0
        },
        {
          "valueTypeId": 10,
          "valueTypeName": "BlindsSlope",
          "value": 1.0
        },
        {
          "valueTypeId": 46,
          "valueTypeName": "BlindsLevel",
          "value": 0.0
        }
      ]
    }
  ],
  "timestamp": 855000000000
}

doc_tap_errors_three;

doc_tap_get_alldevices_values;

doc_tap_get_alldevices_values_text;

doc_tap_get_savebandwidth;

Variant 1
GET /api/CloudApi/v1/getAllDevicesValues

Variant 2
POST /api/CloudApi/v1/getAllDevicesValues

doc_tap_example_response;

{
 "devices": [
    {
      "deviceId": 1,
      "values": [
        {
          "valueTypeId": 7,
          "valueTypeName": "DeviceStatus",
          "value": 0
        },
        {
          "valueTypeId": 42,
          "valueTypeName": "AnalogOutputValue",
          "value": 1
        },
        {
          "valueTypeId": 48,
          "valueTypeName": "SwitchState",
          "value": 1
        },
        {
          "valueTypeId": 67,
          "valueTypeName": "AnalogOutputDesiredValue",
          "value": 1
        }
      ]
    },
    {
      "deviceId": 2,
      "values": [
        {
          "valueTypeId": 7,
          "valueTypeName": "DeviceStatus",
          "value": 0
        },
        {
          "valueTypeId": 10,
          "valueTypeName": "BlindsSlope",
          "value": 1.0
        },
        {
          "valueTypeId": 46,
          "valueTypeName": "BlindsLevel",
          "value": 0.0
        }
      ]
    }
  ],
  "timestamp": 855000000000
}

doc_tap_errors_three;

doc_tap_get_one_device_value;

doc_tap_text_one_value_first;

doc_tap_text_one_value_second;

doc_tap_text_one_value_third;

GET /api/CloudApi/v1/getOneDeviceValue/{deviceId}?valueTypeId={valueTypeId}&token={theToken}

doc_tap_smekolista;

1.27

doc_tap_errors_four;

doc_tap_set_device_value;

doc_tap_device_value_text;

Variant 1
GET /api/TapHomeApi/v1/setDeviceValue/{deviceId}?valueTypeId={valueTypeId1}&value={value1}&valueTypeId2={valueTypeId2}&value2={value2}&valueTypeId3={valueTypeId3}&value3={value3}&
token={theToken}

doc_tap_parameters_device_value;

doc_tap_device_value_text_two;

Variant 2
POST /api/TapHomeApi/v1/setDeviceValue

doc_tap_parameters_x;

{
  "deviceId": 2,
  "values": [
    {
      "valueTypeId": 46,
      "value": 0.1
    },
    {
      "valueTypeId": 10,
      "value": 0.2
    }
  ]
}

doc_tap_example_response_x;

{
  "deviceId": 2,
  "valuesChanged": [
    {
      "typeId": 46,
      "result": "changed"
    },
    {
      "typeId": 10,
      "result": "notchanged"
    },
    {
      "typeId": 7,
      "result": "failed"
    }
  ],
  "timestamp": 855000000000
}

doc_tap_possible_errors_x;

Documentation EN

Cloud API

doc_tap_what_is;

doc_tap_authenticating;

doc_tap_how_to_token;

doc_tap_get_device_value;

doc_tap_get_multipledevices_values;

doc_tap_get_alldevices_values;

doc_tap_get_one_device_value;

doc_tap_set_device_value;

Related content