> For the complete documentation index, see [llms.txt](https://cupnoodles.gitbook.io/open-api/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cupnoodles.gitbook.io/open-api/master.md).

# Introduction

This document introduces how to integrate Yeelight products to third-party service or platform.

Yeelight supports OAuth2.0 with an authorization code flow by Passport, providing all the information that third-party needs to implement OAuth, such as Client ID, Client Secret, Authorization Endpoint and Token Exchange Endpoint.

Yeelight will provide a key for each third-party, and third-party needs to put this key in the header of each request.

If the property change notify is required, third-party needs to provide Property Change Report Endpoint.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://cupnoodles.gitbook.io/open-api/master.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.