# Facade API

> 了解如何在 Univer Boards 应用中使用 Facade API。

- Human documentation: [https://docs.univer.ai/zh-CN/guides/boards/getting-started/facade](https://docs.univer.ai/zh-CN/guides/boards/getting-started/facade)

- Agent Markdown: [https://docs.univer.ai/zh-CN/guides/boards/getting-started/facade.md](https://docs.univer.ai/zh-CN/guides/boards/getting-started/facade.md)

- Requested language: `zh-CN`

- Content language: `zh-CN`

- Documentation version: `1.0.0-rc.0`

- Source: [boards/getting-started/facade.zh-CN.mdx](https://github.com/dream-num/documentation/blob/dev/content/guides/boards/getting-started/facade.zh-CN.mdx)

---

Facade API 在 Univer 服务和单元模型之上提供了面向应用的接口层。你可以用它执行常见的 Board 操作，例如创建画板、读取当前页面、添加元素、更新容器和管理泳道。

> [!WARNING: 注意]
> Board 变更 API 是同步的，并返回 `boolean` 或可为空的句柄。读取结果前请检查返回值。

## 启用 Facade 入口

Boards 以 Web SDK 插件的形式分发。请为应用所使用的 Board 功能导入对应的 Facade 入口：

```ts
import { FUniver } from '@univerjs/core/facade'
import '@univerjs-pro/boards/facade'
```

注册 Univer 实例和所需插件后，创建 API 对象：

```ts
const univerAPI = FUniver.newAPI(univer)
```

## 后续阅读

Facade 扩展现已启用。接下来可以阅读：

* [通用 API](https://docs.univer.ai/zh-CN/guides/boards/features/core/general-api.md)：了解共享的命令、事件、撤销与重做、UI 扩展、网络、枚举和工具方法。
* [Univer Boards API](https://docs.univer.ai/zh-CN/guides/boards/features/core/boards-api.md)：了解如何创建和读取 Board。
* [元素](https://docs.univer.ai/zh-CN/guides/boards/features/core/elements.md)和 [Boards facade 参考](https://docs.univer.ai/zh-CN/reference/facade/boards.md)：了解详细的 Board 操作。