Download the PHP package supla/api-client without Composer

On this page you can find all versions of the php package supla/api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of supla/api-client

Informations about the package api-client

SUPLA API Client for PHP

Latest Release Build Status Packagist Downloads

Your home connected. www.supla.org

Installation

Requires PHP 7.4 or later.

Install with Composer.

Getting Started

Examples

See the examples folder for more.

API Endpoints

All URIs are relative to https://YOUR_SUPLA_SERVER/api/v3.

Class Method HTTP request Description
AccessIdentifiersApi createAccessIdentifier POST /accessids Create a new Access Identifier
AccessIdentifiersApi deleteAccessIdentifier DELETE /accessids/{id} Delete the access identifier
AccessIdentifiersApi getAccessIdentifier GET /accessids/{id} Get AID by ID
AccessIdentifiersApi getAccessIdentifiers GET /accessids Get Access Identifiers
AccessIdentifiersApi updateAccessIdentifier PUT /accessids/{id} Update the access identifier
ChannelGroupsApi createChannelGroup POST /channel-groups Create a new channel group
ChannelGroupsApi deleteChannelGroup DELETE /channel-groups/{id} Delete the channel group
ChannelGroupsApi executeActionOnChannelGroup PATCH /channel-groups/{id}
ChannelGroupsApi getChannelGroup GET /channel-groups/{id} Get Channel Group
ChannelGroupsApi getChannelGroupDirectLinks GET /channel-groups/{channelGroup}/direct-links Get channel group direct links
ChannelGroupsApi getChannelGroupScenes GET /channel-groups/{channelGroup}/scenes Get channel group scenes
ChannelGroupsApi getChannelGroups GET /channel-groups Get Channel Groups
ChannelGroupsApi updateChannelGroup PUT /channel-groups/{id} Update the channel group
ChannelsApi configureChannel PATCH /channels/{id}/settings
ChannelsApi createChannelReaction POST /channels/{channel}/reactions Create channel reaction
ChannelsApi deleteChannel DELETE /channels/{id} Delete the channel
ChannelsApi deleteChannelMeasurementLogs DELETE /channels/{channel}/measurement-logs Delete channel measurement logs.
ChannelsApi deleteChannelReaction DELETE /channels/{channel}/reactions/{reaction} Delete channel reaction
ChannelsApi downloadChannelMeasurementLogs GET /channels/{channel}/measurement-logs-download Get measurement logs as a zipped CSV file.
ChannelsApi executeAction PATCH /channels/{id}
ChannelsApi executeSubDeviceAction PATCH /channels/{channelId}/subdevice
ChannelsApi getChannel GET /channels/{id} Get Channel
ChannelsApi getChannelChannelGroups GET /channels/{id}/channel-groups Get Channel Groups that the given channel belongs to
ChannelsApi getChannelDirectLinks GET /channels/{channel}/direct-links Get channel direct links
ChannelsApi getChannelMeasurementLogs GET /channels/{channel}/measurement-logs Get channel measurement logs.
ChannelsApi getChannelNotifications GET /channels/{channel}/notifications
ChannelsApi getChannelReaction GET /channels/{channel}/reactions/{reaction} Get channel reaction
ChannelsApi getChannelReactions GET /channels/{channel}/reactions Get channel reactions
ChannelsApi getChannelScenes GET /channels/{channel}/scenes Get channel scenes
ChannelsApi getChannels GET /channels Get Channels
ChannelsApi getChannelsStates GET /channels/states Get Channels states
ChannelsApi getReactions GET /reactions Get reactions
ChannelsApi updateChannel PUT /channels/{id}
ChannelsApi updateChannelReaction PUT /channels/{channel}/reactions/{reaction} Update channel reaction
ClientAppsApi deleteClientApp DELETE /client-apps/{id} Delete the client app
ClientAppsApi getClientApps GET /client-apps Get Client Apps
ClientAppsApi updateClientApp PUT /client-apps/{id} Update the client app
DevicesApi deleteDevice DELETE /iodevices/{id} Delete the device
DevicesApi executeDeviceAction PATCH /iodevices/{id}
DevicesApi getIoDevice GET /iodevices/{id} Get Device
DevicesApi getIoDeviceNotifications GET /iodevices/{device}/notifications
DevicesApi getIoDevices GET /iodevices Get Devices
DevicesApi getSubDevices GET /subdevices
DevicesApi updateDevice PUT /iodevices/{id}
DirectLinksApi getDirectLink GET /direct-links/{directLink} Get direct link
DirectLinksApi getDirectLinks GET /direct-links Get Direct Links
EnumsApi getActionsEnum GET /enum/actions
EnumsApi getChannelTypesEnum GET /enum/channel-types
EnumsApi getFunctionsEnum GET /enum/functions
IntegrationsApi createMqttBrokerCredentials POST /integrations/mqtt-credentials Creates MQTT Broker credentials for the OAuth Client.
LocationsApi createLocation POST /locations Create a new location
LocationsApi deleteLocation DELETE /locations/{id} Delete the location
LocationsApi getLocation GET /locations/{id} Get location by ID
LocationsApi getLocations GET /locations Get locations
LocationsApi updateLocation PUT /locations/{id} Update the location
NotificationsApi getNotification GET /notifications/{id} Get Notification
NotificationsApi sendNotification PATCH /notifications Send a notification.
NotificationsApi updateNotification PUT /notifications/{notification}
OAuthApi issueAccessToken POST /oauth/v2/token Issues an access token based on authorization_code or refresh_token.
ScenesApi createScene POST /scenes Create a scene
ScenesApi deleteScene DELETE /scenes/{scene} Delete the scene
ScenesApi executeScene PATCH /scenes/{scene}
ScenesApi getScene GET /scenes/{scene} Get Scene
ScenesApi getSceneDirectLinks GET /scenes/{scene}/direct-links Get scene direct links
ScenesApi getSceneScenes GET /scenes/{scene}/scenes Get scene scenes
ScenesApi getScenes GET /scenes Get Scenes
ScenesApi updateScene PUT /scenes/{scene} Update the scene
SchedulesApi getSchedules GET /schedules Get Schedules
ServerApi getServerInfo GET /server-info Get the server info
ServerApi getSuplaServerStatus GET /server-status Get the SUPLA Server status
ServerApi getTokenInfo GET /token-info Returns information about used access token
UserIconsApi createUserIcon POST /user-icons Create a new User Icon
UserIconsApi createUserIconBase64 POST /user-icons.base64 Create a new User Icon sent in Base64 format.
UserIconsApi deleteUserIcon DELETE /user-icons/{id} Delete the User Icon
UserIconsApi getUserIcon GET /user-icons/{id} Get User Icon
UserIconsApi getUserIconImage GET /user-icons/{id}/{imageIndex} Get User Icon image at specified index
UserIconsApi getUserIcons GET /user-icons List User Icons
UsersApi getCurrentUser GET /users/current Get info about user for the token.

Models

Authorization

Personal Access Token

Generate a Personal Access Token for you in the Integrations section on https://cloud.supla.org or your server instance.

OAuth2

Sources

This PHP package is automatically generated by the OpenAPI Generator project:

All versions of api-client with dependencies

PHP Build Version
Package Version
Requires php Version ^7.4 || ^8.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package supla/api-client contains the following files

Loading the files please wait ....