Daikin Airzone Api Integration Manual

Daikin Airzone Api Integration Manual

Dkn cloud wi-fi adaptor

Advertisement

IM-DKNAPI-201908
API Integration Manual
For
Daikin DKN Cloud Wi-Fi Adaptor

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the Airzone and is the answer not in the manual?

Questions and answers

Summary of Contents for Daikin Airzone

  • Page 1 IM-DKNAPI-201908 API Integration Manual Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 2: Table Of Contents

    TABLE OF CONTENTS 1 Introduction ............................2 2 Authentication ............................3 Oauth2 Fundamentals ............................3 2.1.1 Oauth Roles ............................... 3 2.1.2 Third Party Client Application Registration ....................3 2.1.3 Client ID and Client Secret ......................... 3 Oauth2 Authorization Code Grant Type ......................4 2.2.1 Refresh Token ............................
  • Page 3: Introduction

    1 INTRODUCTION The following document describes the use of the DKN Cloud NA third party API, further on called Open API, including the authentication flow and all available requests/actions. API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 4: Authentication

    Once the third party application is registered, the Open API service will issue "client credentials" in the form of a client identifier and a client secret. The Client ID is a publicly exposed string that is API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 5: Oauth2 Authorization Code Grant Type

    5. If the application identity is authenticated (registered in the Open API environment) and the authorization grant is valid (Code hasn’t expired or already been used), the authorization server (API) issues a pair of access token/refresh token to the application. Authorization is complete. API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 6: Refresh Token

    Here is an explanation of the link components. The parameters are set in querystring format:  https://dkncloudna.com/#/oauth the API authorization endpoint.  client_id=CLIENT_ID: the application's client ID (how the API identifies the application). API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 7 Step 2. Once the user is logged in, an authorization site will appear which will request the user to authorize or deny the third party service to access the user’s information regarding installations and devices stored in DKN Cloud NA: API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 8: Programmatic Interface

    The value of this field is needed for the next request. It acts as an authentication token for the DKN Cloud NA environment, identifying the request in behalf of the user. Step 3. Authorization of the third party service: API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 9 (String) value of the client_id token issued for the entity. client_secret: (String) value of the client_secret token issued for the entity. code: (String) value of the code parameter acquired in the previous request. EXAMPLE: API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 10 (String) value of the client_secret token issued for the entity. refresh_token: (String) value of a valid refresh token for that user. EXAMPLE: curl --location --request POST "https://www.dkncloudna.com/api/v1/open/oauth2/token" \ --header "Content-Type: application/x-www-form-urlencoded" \ API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 11: Oauth2 Best Practices

    The way this works is that you send a random value when starting an authentication request and validate the received value when processing the response. API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 12 Authorization Server they sent an Authorization Request to and bind this information to the user agent (browser sent from) and ensure any sub-sequent messages are sent to the same Authorization Server. API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 13: Api

    "units": 0, "schedules": [{ "devices": ["AA:BB:CC:DD:EE:0D"], "hour": 14, "minutes": 32, "power": "on", "mode": 1, "temp": 23, "vent": 3, "days": [ 0,1,2,3,5,6], "name": "Program_1", "enabled": true, "_id": "5be1b5d973269f2fcc88386b" "added_at": "2019-02-10T06:49:58.591Z", "type": "advanced" API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 14 6], where 0 corresponds to Sunday and 6 to Saturday.  name: name of the schedule.  enabled: (Boolean) whether the schedule is activated (true) or not (false).  _id: schedule unique identifier. API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 15: Device State

    The following requests execute idempotent actions over a device. Every action, in case of being correctly executed, will return the device’s state after applying the command. The format of the response is the same as the previous device state request. API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 16: Device - State

    "value": 18 "maximumValue": { "value": 30 Where the minimumValue and maximumValue objects represent the minimum and maximum values allowed respectively. 3.2.3 Device – Mode Change the AC’s operation mode. REQUEST: PUT https://dkncloudna.com/api/v1/open/{{INSTALLTION_ID}}/{{MAC}}/mode API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 17: Device - Speed

    A successful command for On/Off or Setpoint or Mode change or Fan speed change shall get a response with current condition of the unit: "mode": 2, "power": true, "setpoint": 65, "temperature": 79, "speed": 2, "isConnected": true API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 18: Errors

    Cloud. Error code: 422. Example response: "_id": "deviceNotConnected", "msg": "Device currently not connected to the cloud" deviceNotFound: Returned when the specified MAC doesn’t match to any existing device. Error code: 422. Example response: "_id": "deviceNotFound", API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 19 "msg": "Unknown Error. Try again later" userNotExist: Returned when the user making the request cannot be found in the database. Error code: 400. Example response: "_id": "userNotExist", "msg": "No user found with specified data" API Integration Manual for Daikin DKN Cloud Wi-Fi Adaptor...
  • Page 20  Only qualified personnel must complete the installation. WARNING  Consult your Daikin dealer regarding relocation and reinstallation of the remote controller. Improper installation may result in electric shock or fire.  Electrical work must be performed in accordance with relevant local and national regulations, and with the instructions in this installation manual.

Table of Contents