Philips Hue Installation Instructions
Before You Begin
Before you begin, you need to obtain credentials from Philips Hue. These can be provided by your MiSP or an Integrator. If you have a Philips Hue Developer account, you can obtain these yourself.
IMPORTANT! Work with your MiSP or Integrator to set up OAuth authentication using these settings. You cannot use your subscription until OAuth Authentication has been successfully set up. |
Log in to your Philips Hue Developer account at
https://developers.meethue.com/my-apps/On the Remote Hue API appids page. , click Add new remote Hue API app.
Fill in the Add new Hue Remote API app page.
Give your app a unique App Name and fill in the Application description.
Use one of the following for the Callback URL value:
Staging:
https://stagingapi.ipaas.com/HookApi/v2/Authorization/AuthorizationCompleteProduction:
https://api.ipaas.com/HookApi/v2/Authorization/AuthorizationComplete
Copy the Client ID and Client Secret from the Application Created Successfully dialog box.
With this information, you can create a subscription.
Installation Instructions for Integration Setup
Go to Subscriptions Management and click Search Certified Integration Marketplace and Subscribe.
Click the Philips Hue Integration title.
Click Subscribe.
Enter the name of the subscription and select a version. It can be set to any relevant and unique subscription name within the company where this subscription is created.
Format: [Product Name] - [Environment/Purpose]
Example: Philips Hue – The Example Company
Select Create Default Mappings (recommended).
Enter the Hue Bridge User name.
Enter the Access Token and the Refresh Token.
Enter the Refresh Date.
Enter the API Throttle Limit. This setting prevents any single integration or user from overwhelming the system with too many requests. It protects system performance by controlling the number of API requests that can run simultaneously, ensuring fair usage.
Recommended Values
Initial Setup: 5
Ongoing Operations: 500
High Volume: 500
Enter the API Throttle Seconds. This defines the time window during which the API Throttle Limit is measured. If an integration makes too many requests within this time window, additional requests are rejected until the window resets.
Default Value: 60 seconds
Range: 60 seconds
Enter the number of Concurrent Connections. This specifies the maximum number of simultaneous API connections that the subscription can process for a user or integration. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Enter the number of Concurrent Batch Executions. This specifies the maximum number of simultaneous batch executions that can process for an integration at one time. If this limit is exceeded, new requests are queued or rejected until a currently active connection finishes.
Default Value: 5
Range: 10
Click Apply to save the settings.
Post-Installation Verification
After completing the installation, perform these tests to verify the installation:
Connection Test: The connection functionality will be tested as part of Data Sync and Functionality tests.
Data Sync Test and Functionality Test: This procedure tests both Data Sync and Functionality.
Navigate to Data Management > Customer and clickAdd Customer. Fill in the required and desired fields according to the mapping collection guidelines, then click the Apply button.
Select Edit customer record on the newly created customer.
Copy the customer record ID from the browser URL.
Navigate to Integration Monitoring > Manual Sync.
Configure the following settings:
System: Philips Hue
Mapping Collection: Philips Hue Add/Update Customer from iPaaS
Scopes: customer/created or customer/updated
Enter the customer record ID in the iPaaS.com ID field.
Click the Debug button.
These steps should help to cover all scenarios, including Connection Test.
Support and Troubleshooting
Click the Help button on any iPaaS.com page to contact Support or to search our documentation.
Documentation: Search our documentation at the top of this article
Support Portal: Click the Help and Support button at the lower-right of this window.
Contact Information: Contact iPaaS.com.