integration_kit

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
Next revisionBoth sides next revision
integration_kit [2019/09/23 00:02] – wikiadminintegration_kit [2019/12/03 18:59] – [Local based integration] ingrid
Line 42: Line 42:
 ==== Local based integration ==== ==== Local based integration ====
  
-The communication between third party service and the server is direct and don’t require any internet connection. The third party app directly authenticate with Thinknx server. Authentication can be Simple Auth or Digest Auth.  The server will respond to its IP at port 5051.+The communication between third party service and the server is direct and don’t require any internet connection. The third party app can directly authenticate with Thinknx server. Authentication can be Simple Auth or Digest Auth.  The server will respond to its IP at port 5051.
 All the API calls have the following form: All the API calls have the following form:
  
Line 54: Line 54:
 Thinknx servers are connected through internet to Thinknx Cloud service. Thinknx Cloud service permits to access to the servers independently from the network structure and to remotely control them. Each Thinknx server is identified by its own serial number and by a so called “Integration Kit” key. This key is an alphanumerical code that will be used to route the calls from the Cloud server to the correspondent Thinknx server. The key need to be enabled and generated from the Thinknx server web pages under "Server" tab, "Thinknx Cloud" page. Click on "Enable Integration Kit". Thinknx servers are connected through internet to Thinknx Cloud service. Thinknx Cloud service permits to access to the servers independently from the network structure and to remotely control them. Each Thinknx server is identified by its own serial number and by a so called “Integration Kit” key. This key is an alphanumerical code that will be used to route the calls from the Cloud server to the correspondent Thinknx server. The key need to be enabled and generated from the Thinknx server web pages under "Server" tab, "Thinknx Cloud" page. Click on "Enable Integration Kit".
 \\ <WRAP centeralign>{{ :IFTTT_enable_integrationkit.png?direct600 |Enable integration kit}}</WRAP> \\ <WRAP centeralign>{{ :IFTTT_enable_integrationkit.png?direct600 |Enable integration kit}}</WRAP>
-<WRAP center 50%> <WRAP centeralign> Figure 1.1: Enable Integration Kit</WRAP></WRAP>+<WRAP center 50%> <WRAP centeralign>Enable Integration Kit Key</WRAP></WRAP>
  
 Key permits to directly connect to the server without additional authentication; for this reason it should be kept secret and these precautions should be taken into account while writing code or using cloud based integration: Key permits to directly connect to the server without additional authentication; for this reason it should be kept secret and these precautions should be taken into account while writing code or using cloud based integration:
Line 63: Line 63:
 All the API calls used over cloud have the following form: All the API calls used over cloud have the following form:
  
-**%%https://data.thinknx.eu/KEY/controller?param1=value1&param2=value2%%**+**%%https://data.thinknx.eu/KEY/api/V1/controller?param1=value1&param2=value2%%**
  
 HTTP calls will be redirect to HTTPS. HTTP calls will be redirect to HTTPS.
Line 99: Line 99:
   * Generic Button   * Generic Button
     * Trigger Controller – Can trigger the actions associated with an endpoint     * Trigger Controller – Can trigger the actions associated with an endpoint
 +
 +From Thinknx server webpages inside "Server" tab, page "Integration Kit" it is possible to see the entire tree of the project running on the server. Going to the desired object to be controlled is possible to see the supported commands, to simulate them or to copy the URL to be able to send the command remotely. 
 +\\ <WRAP centeralign>{{ :IFTTT_URL_thinknx.png?direct600 |Copy IFTTT url}}</WRAP>
 +<WRAP center 50%> <WRAP centeralign>Project tree with API description</WRAP></WRAP>
 +
  
 ==== Asynchronous events (coming soon) ==== ==== Asynchronous events (coming soon) ====
Line 1395: Line 1400:
  
 ^ Description  ^ Get the most important information from server | ^ Description  ^ Get the most important information from server |
-^ URL          |//**api/v1/system/sendKNXfloat4bytes**//      |+^ URL          |//**api/v1/system/serverStatus**//      |
 ^ URL Params   |not required | ^ URL Params   |not required |
 ^Data Params   |not required | ^Data Params   |not required |
  • integration_kit.txt
  • Last modified: 2022/09/06 13:22
  • by wikiadmin