PHPackages supla/api-client - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. supla/api-client ActiveLibrary[API Development](/categories/api) supla/api-client ================ v25.04(1y ago)7934↓100%2[5 PRs](https://github.com/SUPLA/api-client-php/pulls)GPL-2.0-onlyPHPPHP ^7.4 || ^8.0CI passing Since Aug 21Pushed 2mo ago4 watchersCompare [ Source](https://github.com/SUPLA/api-client-php)[ Packagist](https://packagist.org/packages/supla/api-client)[ Docs](https://cloud.supla.org)[ RSS](/packages/supla-api-client/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (4)Versions (20)Used By (0) SUPLA API Client for PHP ======================== [](#supla-api-client-for-php) [![Latest Release](https://camo.githubusercontent.com/53c24bc3db542ad185cb8d3de011f22a8ed05f725c1e2e7084fc9ac88773c23b/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f72656c656173652f5355504c412f6170692d636c69656e742d7068702e737667)](https://github.com/SUPLA/api-client-php/releases/latest)[![Build Status](https://camo.githubusercontent.com/eefca5c0ce203e2d91dbdea1e5ee78521cbaca02077f76f0e8b2717a013ca0a9/68747470733a2f2f7472617669732d63692e6f72672f5355504c412f6170692d636c69656e742d7068702e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/SUPLA/supla-cloud)[![Packagist Downloads](https://camo.githubusercontent.com/9962a99b04781ee0830e7a51426c9e2701f1531c6b60332c0315c58dfc9c8e6e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f5355504c412f6170692d636c69656e742e737667)](https://packagist.org/packages/supla/api-client) Your home connected. [www.supla.org](http://www.supla.org) Installation ============ [](#installation) Requires PHP 7.4 or later. Install with [Composer](https://getcomposer.org/). Getting Started --------------- [](#getting-started) ``` require_once(__DIR__ . '/vendor/autoload.php'); use Supla\ApiClient\Api\ChannelsApi; // Get access token from OAuth flow or use a Personal Access Token $accessToken = ''; $config = Supla\ApiClient\Configuration::getDefaultConfiguration()->setAccessToken($accessToken); $apiInstance = new ChannelsApi(new GuzzleHttp\Client(), $config); try { $result = $apiInstance->getChannels(); print_r($result); } catch (Exception $e) { echo 'Exception when calling SUPLA API: ', $e->getMessage(), PHP_EOL; } ``` Examples -------- [](#examples) See the [examples folder](https://github.com/SUPLA/api-client-php/tree/master/examples) for more. API Endpoints ------------- [](#api-endpoints) All URIs are relative to `https://YOUR_SUPLA_SERVER/api/v3`. ClassMethodHTTP requestDescription*AccessIdentifiersApi*[**createAccessIdentifier**](docs/Api/AccessIdentifiersApi.md#createaccessidentifier)**POST** /accessidsCreate a new Access Identifier*AccessIdentifiersApi*[**deleteAccessIdentifier**](docs/Api/AccessIdentifiersApi.md#deleteaccessidentifier)**DELETE** /accessids/{id}Delete the access identifier*AccessIdentifiersApi*[**getAccessIdentifier**](docs/Api/AccessIdentifiersApi.md#getaccessidentifier)**GET** /accessids/{id}Get AID by ID*AccessIdentifiersApi*[**getAccessIdentifiers**](docs/Api/AccessIdentifiersApi.md#getaccessidentifiers)**GET** /accessidsGet Access Identifiers*AccessIdentifiersApi*[**updateAccessIdentifier**](docs/Api/AccessIdentifiersApi.md#updateaccessidentifier)**PUT** /accessids/{id}Update the access identifier*ChannelGroupsApi*[**createChannelGroup**](docs/Api/ChannelGroupsApi.md#createchannelgroup)**POST** /channel-groupsCreate a new channel group*ChannelGroupsApi*[**deleteChannelGroup**](docs/Api/ChannelGroupsApi.md#deletechannelgroup)**DELETE** /channel-groups/{id}Delete the channel group*ChannelGroupsApi*[**executeActionOnChannelGroup**](docs/Api/ChannelGroupsApi.md#executeactiononchannelgroup)**PATCH** /channel-groups/{id}*ChannelGroupsApi*[**getChannelGroup**](docs/Api/ChannelGroupsApi.md#getchannelgroup)**GET** /channel-groups/{id}Get Channel Group*ChannelGroupsApi*[**getChannelGroupDirectLinks**](docs/Api/ChannelGroupsApi.md#getchannelgroupdirectlinks)**GET** /channel-groups/{channelGroup}/direct-linksGet channel group direct links*ChannelGroupsApi*[**getChannelGroupScenes**](docs/Api/ChannelGroupsApi.md#getchannelgroupscenes)**GET** /channel-groups/{channelGroup}/scenesGet channel group scenes*ChannelGroupsApi*[**getChannelGroups**](docs/Api/ChannelGroupsApi.md#getchannelgroups)**GET** /channel-groupsGet Channel Groups*ChannelGroupsApi*[**updateChannelGroup**](docs/Api/ChannelGroupsApi.md#updatechannelgroup)**PUT** /channel-groups/{id}Update the channel group*ChannelsApi*[**configureChannel**](docs/Api/ChannelsApi.md#configurechannel)**PATCH** /channels/{id}/settings*ChannelsApi*[**createChannelReaction**](docs/Api/ChannelsApi.md#createchannelreaction)**POST** /channels/{channel}/reactionsCreate channel reaction*ChannelsApi*[**deleteChannel**](docs/Api/ChannelsApi.md#deletechannel)**DELETE** /channels/{id}Delete the channel*ChannelsApi*[**deleteChannelMeasurementLogs**](docs/Api/ChannelsApi.md#deletechannelmeasurementlogs)**DELETE** /channels/{channel}/measurement-logsDelete channel measurement logs.*ChannelsApi*[**deleteChannelReaction**](docs/Api/ChannelsApi.md#deletechannelreaction)**DELETE** /channels/{channel}/reactions/{reaction}Delete channel reaction*ChannelsApi*[**downloadChannelMeasurementLogs**](docs/Api/ChannelsApi.md#downloadchannelmeasurementlogs)**GET** /channels/{channel}/measurement-logs-downloadGet measurement logs as a zipped CSV file.*ChannelsApi*[**executeAction**](docs/Api/ChannelsApi.md#executeaction)**PATCH** /channels/{id}*ChannelsApi*[**executeSubDeviceAction**](docs/Api/ChannelsApi.md#executesubdeviceaction)**PATCH** /channels/{channelId}/subdevice*ChannelsApi*[**getChannel**](docs/Api/ChannelsApi.md#getchannel)**GET** /channels/{id}Get Channel*ChannelsApi*[**getChannelChannelGroups**](docs/Api/ChannelsApi.md#getchannelchannelgroups)**GET** /channels/{id}/channel-groupsGet Channel Groups that the given channel belongs to*ChannelsApi*[**getChannelDirectLinks**](docs/Api/ChannelsApi.md#getchanneldirectlinks)**GET** /channels/{channel}/direct-linksGet channel direct links*ChannelsApi*[**getChannelMeasurementLogs**](docs/Api/ChannelsApi.md#getchannelmeasurementlogs)**GET** /channels/{channel}/measurement-logsGet channel measurement logs.*ChannelsApi*[**getChannelNotifications**](docs/Api/ChannelsApi.md#getchannelnotifications)**GET** /channels/{channel}/notifications*ChannelsApi*[**getChannelReaction**](docs/Api/ChannelsApi.md#getchannelreaction)**GET** /channels/{channel}/reactions/{reaction}Get channel reaction*ChannelsApi*[**getChannelReactions**](docs/Api/ChannelsApi.md#getchannelreactions)**GET** /channels/{channel}/reactionsGet channel reactions*ChannelsApi*[**getChannelScenes**](docs/Api/ChannelsApi.md#getchannelscenes)**GET** /channels/{channel}/scenesGet channel scenes*ChannelsApi*[**getChannels**](docs/Api/ChannelsApi.md#getchannels)**GET** /channelsGet Channels*ChannelsApi*[**getChannelsStates**](docs/Api/ChannelsApi.md#getchannelsstates)**GET** /channels/statesGet Channels states*ChannelsApi*[**getReactions**](docs/Api/ChannelsApi.md#getreactions)**GET** /reactionsGet reactions*ChannelsApi*[**updateChannel**](docs/Api/ChannelsApi.md#updatechannel)**PUT** /channels/{id}*ChannelsApi*[**updateChannelReaction**](docs/Api/ChannelsApi.md#updatechannelreaction)**PUT** /channels/{channel}/reactions/{reaction}Update channel reaction*ClientAppsApi*[**deleteClientApp**](docs/Api/ClientAppsApi.md#deleteclientapp)**DELETE** /client-apps/{id}Delete the client app*ClientAppsApi*[**getClientApps**](docs/Api/ClientAppsApi.md#getclientapps)**GET** /client-appsGet Client Apps*ClientAppsApi*[**updateClientApp**](docs/Api/ClientAppsApi.md#updateclientapp)**PUT** /client-apps/{id}Update the client app*DevicesApi*[**deleteDevice**](docs/Api/DevicesApi.md#deletedevice)**DELETE** /iodevices/{id}Delete the device*DevicesApi*[**executeDeviceAction**](docs/Api/DevicesApi.md#executedeviceaction)**PATCH** /iodevices/{id}*DevicesApi*[**getIoDevice**](docs/Api/DevicesApi.md#getiodevice)**GET** /iodevices/{id}Get Device*DevicesApi*[**getIoDeviceNotifications**](docs/Api/DevicesApi.md#getiodevicenotifications)**GET** /iodevices/{device}/notifications*DevicesApi*[**getIoDevices**](docs/Api/DevicesApi.md#getiodevices)**GET** /iodevicesGet Devices*DevicesApi*[**getSubDevices**](docs/Api/DevicesApi.md#getsubdevices)**GET** /subdevices*DevicesApi*[**updateDevice**](docs/Api/DevicesApi.md#updatedevice)**PUT** /iodevices/{id}*DirectLinksApi*[**getDirectLink**](docs/Api/DirectLinksApi.md#getdirectlink)**GET** /direct-links/{directLink}Get direct link*DirectLinksApi*[**getDirectLinks**](docs/Api/DirectLinksApi.md#getdirectlinks)**GET** /direct-linksGet Direct Links*EnumsApi*[**getActionsEnum**](docs/Api/EnumsApi.md#getactionsenum)**GET** /enum/actions*EnumsApi*[**getChannelTypesEnum**](docs/Api/EnumsApi.md#getchanneltypesenum)**GET** /enum/channel-types*EnumsApi*[**getFunctionsEnum**](docs/Api/EnumsApi.md#getfunctionsenum)**GET** /enum/functions*IntegrationsApi*[**createMqttBrokerCredentials**](docs/Api/IntegrationsApi.md#createmqttbrokercredentials)**POST** /integrations/mqtt-credentialsCreates MQTT Broker credentials for the OAuth Client.*LocationsApi*[**createLocation**](docs/Api/LocationsApi.md#createlocation)**POST** /locationsCreate a new location*LocationsApi*[**deleteLocation**](docs/Api/LocationsApi.md#deletelocation)**DELETE** /locations/{id}Delete the location*LocationsApi*[**getLocation**](docs/Api/LocationsApi.md#getlocation)**GET** /locations/{id}Get location by ID*LocationsApi*[**getLocations**](docs/Api/LocationsApi.md#getlocations)**GET** /locationsGet locations*LocationsApi*[**updateLocation**](docs/Api/LocationsApi.md#updatelocation)**PUT** /locations/{id}Update the location*NotificationsApi*[**getNotification**](docs/Api/NotificationsApi.md#getnotification)**GET** /notifications/{id}Get Notification*NotificationsApi*[**sendNotification**](docs/Api/NotificationsApi.md#sendnotification)**PATCH** /notificationsSend a notification.*NotificationsApi*[**updateNotification**](docs/Api/NotificationsApi.md#updatenotification)**PUT** /notifications/{notification}*OAuthApi*[**issueAccessToken**](docs/Api/OAuthApi.md#issueaccesstoken)**POST** /oauth/v2/tokenIssues an access token based on authorization\_code or refresh\_token.*ScenesApi*[**createScene**](docs/Api/ScenesApi.md#createscene)**POST** /scenesCreate a scene*ScenesApi*[**deleteScene**](docs/Api/ScenesApi.md#deletescene)**DELETE** /scenes/{scene}Delete the scene*ScenesApi*[**executeScene**](docs/Api/ScenesApi.md#executescene)**PATCH** /scenes/{scene}*ScenesApi*[**getScene**](docs/Api/ScenesApi.md#getscene)**GET** /scenes/{scene}Get Scene*ScenesApi*[**getSceneDirectLinks**](docs/Api/ScenesApi.md#getscenedirectlinks)**GET** /scenes/{scene}/direct-linksGet scene direct links*ScenesApi*[**getSceneScenes**](docs/Api/ScenesApi.md#getscenescenes)**GET** /scenes/{scene}/scenesGet scene scenes*ScenesApi*[**getScenes**](docs/Api/ScenesApi.md#getscenes)**GET** /scenesGet Scenes*ScenesApi*[**updateScene**](docs/Api/ScenesApi.md#updatescene)**PUT** /scenes/{scene}Update the scene*SchedulesApi*[**getSchedules**](docs/Api/SchedulesApi.md#getschedules)**GET** /schedulesGet Schedules*ServerApi*[**getServerInfo**](docs/Api/ServerApi.md#getserverinfo)**GET** /server-infoGet the server info*ServerApi*[**getSuplaServerStatus**](docs/Api/ServerApi.md#getsuplaserverstatus)**GET** /server-statusGet the SUPLA Server status*ServerApi*[**getTokenInfo**](docs/Api/ServerApi.md#gettokeninfo)**GET** /token-infoReturns information about used access token*UserIconsApi*[**createUserIcon**](docs/Api/UserIconsApi.md#createusericon)**POST** /user-iconsCreate a new User Icon*UserIconsApi*[**createUserIconBase64**](docs/Api/UserIconsApi.md#createusericonbase64)**POST** /user-icons.base64Create a new User Icon sent in Base64 format.*UserIconsApi*[**deleteUserIcon**](docs/Api/UserIconsApi.md#deleteusericon)**DELETE** /user-icons/{id}Delete the User Icon*UserIconsApi*[**getUserIcon**](docs/Api/UserIconsApi.md#getusericon)**GET** /user-icons/{id}Get User Icon*UserIconsApi*[**getUserIconImage**](docs/Api/UserIconsApi.md#getusericonimage)**GET** /user-icons/{id}/{imageIndex}Get User Icon image at specified index*UserIconsApi*[**getUserIcons**](docs/Api/UserIconsApi.md#getusericons)**GET** /user-iconsList User Icons*UsersApi*[**getCurrentUser**](docs/Api/UsersApi.md#getcurrentuser)**GET** /users/currentGet info about user for the token.Models ------ [](#models) - [AccessIdentifier](docs/Model/AccessIdentifier.md) - [AccessIdentifierRelationsCount](docs/Model/AccessIdentifierRelationsCount.md) - [AccessTokenRequestBody](docs/Model/AccessTokenRequestBody.md) - [ActionableSubject](docs/Model/ActionableSubject.md) - [ActionableSubjectTypeNames](docs/Model/ActionableSubjectTypeNames.md) - [ActiveHoursDef](docs/Model/ActiveHoursDef.md) - [Channel](docs/Model/Channel.md) - [ChannelActionParams](docs/Model/ChannelActionParams.md) - [ChannelActionParamsCopy](docs/Model/ChannelActionParamsCopy.md) - [ChannelActionParamsDimmer](docs/Model/ChannelActionParamsDimmer.md) - [ChannelActionParamsDuration](docs/Model/ChannelActionParamsDuration.md) - [ChannelActionParamsPercentage](docs/Model/ChannelActionParamsPercentage.md) - [ChannelActionParamsPercentageAndTilt](docs/Model/ChannelActionParamsPercentageAndTilt.md) - [ChannelActionParamsRgbw](docs/Model/ChannelActionParamsRgbw.md) - [ChannelActionParamsRgbwOneOf](docs/Model/ChannelActionParamsRgbwOneOf.md) - [ChannelActionParamsRgbwOneOf1](docs/Model/ChannelActionParamsRgbwOneOf1.md) - [ChannelActionParamsRgbwOneOf2](docs/Model/ChannelActionParamsRgbwOneOf2.md) - [ChannelActionParamsRgbwOneOf2Hsv](docs/Model/ChannelActionParamsRgbwOneOf2Hsv.md) - [ChannelActionParamsRgbwOneOf3](docs/Model/ChannelActionParamsRgbwOneOf3.md) - [ChannelActionParamsRgbwOneOf3Rgb](docs/Model/ChannelActionParamsRgbwOneOf3Rgb.md) - [ChannelActionParamsRgbwOneOfColor](docs/Model/ChannelActionParamsRgbwOneOfColor.md) - [ChannelActionParamsSend](docs/Model/ChannelActionParamsSend.md) - [ChannelConfig](docs/Model/ChannelConfig.md) - [ChannelConfigActionTrigger](docs/Model/ChannelConfigActionTrigger.md) - [ChannelConfigAlexaSettings](docs/Model/ChannelConfigAlexaSettings.md) - [ChannelConfigAlexaSettingsAlexa](docs/Model/ChannelConfigAlexaSettingsAlexa.md) - [ChannelConfigControllingTheGate](docs/Model/ChannelConfigControllingTheGate.md) - [ChannelConfigControllingTheGateClosingRule](docs/Model/ChannelConfigControllingTheGateClosingRule.md) - [ChannelConfigElectricityMeter](docs/Model/ChannelConfigElectricityMeter.md) - [ChannelConfigFacadeBlinds](docs/Model/ChannelConfigFacadeBlinds.md) - [ChannelConfigFacadeBlindsTimeMargin](docs/Model/ChannelConfigFacadeBlindsTimeMargin.md) - [ChannelConfigGeneralPurposeMeasurement](docs/Model/ChannelConfigGeneralPurposeMeasurement.md) - [ChannelConfigGeneralPurposeMeasurementDefaults](docs/Model/ChannelConfigGeneralPurposeMeasurementDefaults.md) - [ChannelConfigGeneralPurposeMeter](docs/Model/ChannelConfigGeneralPurposeMeter.md) - [ChannelConfigGoogleHomeSettings](docs/Model/ChannelConfigGoogleHomeSettings.md) - [ChannelConfigGoogleHomeSettingsGoogleHome](docs/Model/ChannelConfigGoogleHomeSettingsGoogleHome.md) - [ChannelConfigHumidity](docs/Model/ChannelConfigHumidity.md) - [ChannelConfigHumidityAndThermometer](docs/Model/ChannelConfigHumidityAndThermometer.md) - [ChannelConfigHvacThermostat](docs/Model/ChannelConfigHvacThermostat.md) - [ChannelConfigHvacThermostatSchedule](docs/Model/ChannelConfigHvacThermostatSchedule.md) - [ChannelConfigHvacThermostatTemperatureConstraints](docs/Model/ChannelConfigHvacThermostatTemperatureConstraints.md) - [ChannelConfigHvacThermostatTemperatures](docs/Model/ChannelConfigHvacThermostatTemperatures.md) - [ChannelConfigImpulseCounter](docs/Model/ChannelConfigImpulseCounter.md) - [ChannelConfigInvertedLogic](docs/Model/ChannelConfigInvertedLogic.md) - [ChannelConfigRollerShutter](docs/Model/ChannelConfigRollerShutter.md) - [ChannelConfigStaircaseTimer](docs/Model/ChannelConfigStaircaseTimer.md) - [ChannelConfigThermometer](docs/Model/ChannelConfigThermometer.md) - [ChannelFunction](docs/Model/ChannelFunction.md) - [ChannelFunctionAction](docs/Model/ChannelFunctionAction.md) - [ChannelGroup](docs/Model/ChannelGroup.md) - [ChannelGroupRelationsCount](docs/Model/ChannelGroupRelationsCount.md) - [ChannelRelationsCount](docs/Model/ChannelRelationsCount.md) - [ChannelState](docs/Model/ChannelState.md) - [ChannelStateBrightness](docs/Model/ChannelStateBrightness.md) - [ChannelStateColor](docs/Model/ChannelStateColor.md) - [ChannelStateColorAndBrightness](docs/Model/ChannelStateColorAndBrightness.md) - [ChannelStateConnected](docs/Model/ChannelStateConnected.md) - [ChannelStateDepth](docs/Model/ChannelStateDepth.md) - [ChannelStateDistance](docs/Model/ChannelStateDistance.md) - [ChannelStateDouble](docs/Model/ChannelStateDouble.md) - [ChannelStateElectricityMeter](docs/Model/ChannelStateElectricityMeter.md) - [ChannelStateElectricityMeterPhase](docs/Model/ChannelStateElectricityMeterPhase.md) - [ChannelStateFacadeBlind](docs/Model/ChannelStateFacadeBlind.md) - [ChannelStateHumidity](docs/Model/ChannelStateHumidity.md) - [ChannelStateHumidityAndTemperature](docs/Model/ChannelStateHumidityAndTemperature.md) - [ChannelStateHvac](docs/Model/ChannelStateHvac.md) - [ChannelStateImpulseCounter](docs/Model/ChannelStateImpulseCounter.md) - [ChannelStateOnOff](docs/Model/ChannelStateOnOff.md) - [ChannelStateRelay](docs/Model/ChannelStateRelay.md) - [ChannelStateRollerShutter](docs/Model/ChannelStateRollerShutter.md) - [ChannelStateSensor](docs/Model/ChannelStateSensor.md) - [ChannelStateSensorPartial](docs/Model/ChannelStateSensorPartial.md) - [ChannelStateTemperature](docs/Model/ChannelStateTemperature.md) - [ChannelStateValve](docs/Model/ChannelStateValve.md) - [ChannelType](docs/Model/ChannelType.md) - [ClientApp](docs/Model/ClientApp.md) - [ConfigureChannelRequest](docs/Model/ConfigureChannelRequest.md) - [CreateChannelGroupRequest](docs/Model/CreateChannelGroupRequest.md) - [CreateChannelReactionRequest](docs/Model/CreateChannelReactionRequest.md) - [CreateChannelReactionRequestActionParam](docs/Model/CreateChannelReactionRequestActionParam.md) - [CreateMqttBrokerCredentials200Response](docs/Model/CreateMqttBrokerCredentials200Response.md) - [CreateSceneRequest](docs/Model/CreateSceneRequest.md) - [CreateSceneRequestOperationsInner](docs/Model/CreateSceneRequestOperationsInner.md) - [CreateUserIconBase64Request](docs/Model/CreateUserIconBase64Request.md) - [Device](docs/Model/Device.md) - [DeviceConfig](docs/Model/DeviceConfig.md) - [DeviceConfigHomeScreen](docs/Model/DeviceConfigHomeScreen.md) - [DeviceConfigScreenBrightness](docs/Model/DeviceConfigScreenBrightness.md) - [DeviceConfigUserInterface](docs/Model/DeviceConfigUserInterface.md) - [DeviceConfigUserInterfaceConstraints](docs/Model/DeviceConfigUserInterfaceConstraints.md) - [DeviceManufacturer](docs/Model/DeviceManufacturer.md) - [DeviceRelationsCount](docs/Model/DeviceRelationsCount.md) - [DirectLink](docs/Model/DirectLink.md) - [DirectLinkActiveDateRange](docs/Model/DirectLinkActiveDateRange.md) - [ErrorResponse](docs/Model/ErrorResponse.md) - [ExecuteAction400Response](docs/Model/ExecuteAction400Response.md) - [ExecuteActionOnChannelGroup400Response](docs/Model/ExecuteActionOnChannelGroup400Response.md) - [ExecuteActionOnChannelGroupRequest](docs/Model/ExecuteActionOnChannelGroupRequest.md) - [ExecuteActionRequest](docs/Model/ExecuteActionRequest.md) - [ExecuteScene400Response](docs/Model/ExecuteScene400Response.md) - [ExecuteSceneRequest](docs/Model/ExecuteSceneRequest.md) - [ExecuteSubDeviceActionRequest](docs/Model/ExecuteSubDeviceActionRequest.md) - [GetChannelMeasurementLogs200Response](docs/Model/GetChannelMeasurementLogs200Response.md) - [GetChannelMeasurementLogs200ResponseOneOfInner](docs/Model/GetChannelMeasurementLogs200ResponseOneOfInner.md) - [GetChannelMeasurementLogs200ResponseOneOfInner1](docs/Model/GetChannelMeasurementLogs200ResponseOneOfInner1.md) - [GetChannelMeasurementLogs200ResponseOneOfInner2](docs/Model/GetChannelMeasurementLogs200ResponseOneOfInner2.md) - [GetChannelMeasurementLogs200ResponseOneOfInner3](docs/Model/GetChannelMeasurementLogs200ResponseOneOfInner3.md) - [GetChannelMeasurementLogs200ResponseOneOfInner4](docs/Model/GetChannelMeasurementLogs200ResponseOneOfInner4.md) - [GetChannelMeasurementLogs200ResponseOneOfInner5](docs/Model/GetChannelMeasurementLogs200ResponseOneOfInner5.md) - [GetChannelMeasurementLogs200ResponseOneOfInner6](docs/Model/GetChannelMeasurementLogs200ResponseOneOfInner6.md) - [GetIoDeviceIdParameter](docs/Model/GetIoDeviceIdParameter.md) - [GetServerInfo200Response](docs/Model/GetServerInfo200Response.md) - [GetServerInfo200ResponseTimezone](docs/Model/GetServerInfo200ResponseTimezone.md) - [GetSuplaServerStatus200Response](docs/Model/GetSuplaServerStatus200Response.md) - [GetSuplaServerStatus503Response](docs/Model/GetSuplaServerStatus503Response.md) - [GetTokenInfo200Response](docs/Model/GetTokenInfo200Response.md) - [IssueAccessToken200Response](docs/Model/IssueAccessToken200Response.md) - [Location](docs/Model/Location.md) - [LocationRelationsCount](docs/Model/LocationRelationsCount.md) - [Notification](docs/Model/Notification.md) - [Reaction](docs/Model/Reaction.md) - [ReactionTrigger](docs/Model/ReactionTrigger.md) - [ReactionTriggerChange](docs/Model/ReactionTriggerChange.md) - [ReactionTriggerChangeOnChange](docs/Model/ReactionTriggerChangeOnChange.md) - [ReactionTriggerEq](docs/Model/ReactionTriggerEq.md) - [ReactionTriggerEqOnChangeTo](docs/Model/ReactionTriggerEqOnChangeTo.md) - [ReactionTriggerEqOnChangeToEq](docs/Model/ReactionTriggerEqOnChangeToEq.md) - [ReactionTriggerFieldNames](docs/Model/ReactionTriggerFieldNames.md) - [ReactionTriggerGe](docs/Model/ReactionTriggerGe.md) - [ReactionTriggerGeOnChangeTo](docs/Model/ReactionTriggerGeOnChangeTo.md) - [ReactionTriggerGeOnChangeToResume](docs/Model/ReactionTriggerGeOnChangeToResume.md) - [ReactionTriggerGt](docs/Model/ReactionTriggerGt.md) - [ReactionTriggerGtOnChangeTo](docs/Model/ReactionTriggerGtOnChangeTo.md) - [ReactionTriggerGtOnChangeToResume](docs/Model/ReactionTriggerGtOnChangeToResume.md) - [ReactionTriggerLe](docs/Model/ReactionTriggerLe.md) - [ReactionTriggerLeOnChangeTo](docs/Model/ReactionTriggerLeOnChangeTo.md) - [ReactionTriggerLeOnChangeToResume](docs/Model/ReactionTriggerLeOnChangeToResume.md) - [ReactionTriggerLt](docs/Model/ReactionTriggerLt.md) - [ReactionTriggerLtOnChangeTo](docs/Model/ReactionTriggerLtOnChangeTo.md) - [ReactionTriggerLtOnChangeToResume](docs/Model/ReactionTriggerLtOnChangeToResume.md) - [ReactionTriggerNe](docs/Model/ReactionTriggerNe.md) - [ReactionTriggerNeOnChangeTo](docs/Model/ReactionTriggerNeOnChangeTo.md) - [Scene](docs/Model/Scene.md) - [SceneOperation](docs/Model/SceneOperation.md) - [SceneRelationsCount](docs/Model/SceneRelationsCount.md) - [SceneState](docs/Model/SceneState.md) - [Schedule](docs/Model/Schedule.md) - [ScheduleClosestExecutions](docs/Model/ScheduleClosestExecutions.md) - [ScheduleConfigEntry](docs/Model/ScheduleConfigEntry.md) - [ScheduleConfigEntryAction](docs/Model/ScheduleConfigEntryAction.md) - [ScheduleScheduledExecution](docs/Model/ScheduleScheduledExecution.md) - [ScheduleScheduledExecutionResult](docs/Model/ScheduleScheduledExecutionResult.md) - [ScheduleState](docs/Model/ScheduleState.md) - [SendNotification400Response](docs/Model/SendNotification400Response.md) - [UpdateAccessIdentifierRequest](docs/Model/UpdateAccessIdentifierRequest.md) - [UpdateChannelRequest](docs/Model/UpdateChannelRequest.md) - [UpdateClientAppRequest](docs/Model/UpdateClientAppRequest.md) - [UpdateDeviceRequest](docs/Model/UpdateDeviceRequest.md) - [UpdateLocationRequest](docs/Model/UpdateLocationRequest.md) - [User](docs/Model/User.md) - [UserAgreements](docs/Model/UserAgreements.md) - [UserApiRateLimit](docs/Model/UserApiRateLimit.md) - [UserApiRateLimitRule](docs/Model/UserApiRateLimitRule.md) - [UserApiRateLimitStatus](docs/Model/UserApiRateLimitStatus.md) - [UserIcon](docs/Model/UserIcon.md) - [UserLimits](docs/Model/UserLimits.md) - [UserLimitsPushNotificationsPerHour](docs/Model/UserLimitsPushNotificationsPerHour.md) Authorization ------------- [](#authorization) ### Personal Access Token [](#personal-access-token) Generate a Personal Access Token for you in the **Integrations** section on or your server instance. ### OAuth2 [](#oauth2) - **Flow**: `authorizationCode` - **Authorization URL**: `https://cloud.supla.org/oauth/v2/auth` if the app is public or `https://YOUR_SUPLA_SERVER/oauth/v2/auth` otherwise - **Scopes**: - `accessids_r`: Access Identifiers (read) - `accessids_rw`: Access Identifiers (read and modify) - `account_r`: User account and e-mail address (read) - `account_rw`: User account (read and modify) - `channels_r`: Channels (read) - `channels_rw`: Channels (read and modify) - `channels_ea`: Channels (execute actions) - `channels_files`: Download files from API (measurements history, user icons) - `channelgroups_r`: Channel groups (read) - `channelgroups_rw`: Channel groups (read and modify) - `channelgroups_ea`: Channel groups (execute actions) - `clientapps_r`: Client apps (read) - `clientapps_rw`: Client apps (read and modify) - `directlinks_r`: Direct links (read) - `directlinks_rw`: Direct links (read and modify) - `iodevices_r`: IO Devices (read) - `iodevices_rw`: IO Devices (read and modify) - `locations_r`: Locations (read) - `locations_rw`: Locations (read and modify) - `scenes_r`: Scenes (read) - `scenes_rw`: Scenes (read and modify) - `scenes_ea`: Scenes (execute actions) - `schedules_r`: Schedules (read) - `schedules_rw`: Schedules (read and modify) - `state_webhook`: Access to state webhooks - `mqtt_broker`: MQTT Broker settings - `offline_access`: Issue refresh token - **Example Auth URL**: `/oauth/v2/auth?client_id=YOUR_CLIENT_ID&redirect_uri=YOUR_REDIRECT_URI&response_type=code&scope=account_r%20channels_r&state=example-state` Sources ------- [](#sources) This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - Targeted Cloud version: `25.03` - Build package: `org.openapitools.codegen.languages.PhpClientCodegen` ### Health Score 49 — FairBetter than 94% of packages Maintenance73 Regular maintenance activity Popularity22 Limited adoption so far Community10 Small or concentrated contributor base Maturity77 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~214 days Recently: every ~90 days Total 14 Last Release 400d ago Major Versions v1.0.0 → v2.1.02017-08-21 v2.1.4 → v3.0.0-beta.12022-04-09 v3.0.0-beta.1 → v24.042024-04-08 24.04.02 → v25.012025-01-30 PHP version history (2 changes)v3.0.0-beta.1PHP ^7.3 || ^8.0 v25.04PHP ^7.4 || ^8.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/6049aabec24be39f8daa85222eee768e701f98d0c7b678c1325c2b40c1cfcc07?d=identicon)[fracz](/maintainers/fracz) --- Top Contributors [![fracz](https://avatars.githubusercontent.com/u/3918865?v=4)](https://github.com/fracz "fracz (46 commits)") --- Tags supla ### Code Quality TestsPHPUnit Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/supla-api-client/health.svg) ``` [![Health](https://phpackages.com/badges/supla-api-client/health.svg)](https://phpackages.com/packages/supla-api-client) ``` ### Alternatives [sylius/sylius E-Commerce platform for PHP, based on Symfony framework. 8.4k5.6M647](/packages/sylius-sylius)[saloonphp/saloon Build beautiful API integrations and SDKs with Saloon 2.4k9.6M467](/packages/saloonphp-saloon)[irazasyed/telegram-bot-sdk The Unofficial Telegram Bot API PHP SDK 3.3k4.5M84](/packages/irazasyed-telegram-bot-sdk)[googleads/googleads-php-lib Google Ad Manager SOAP API Client Library for PHP 67410.3M25](/packages/googleads-googleads-php-lib)[hubspot/api-client Hubspot API client 23414.2M16](/packages/hubspot-api-client)[theodo-group/llphant LLPhant is a library to help you build Generative AI applications. 1.5k311.5k5](/packages/theodo-group-llphant) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)