# API & TypeScript SDK

URL: https://openship.io/zh/features/api-sdk

使用记录的 HTTP 路由和类型化客户端自动化平台操作。

通过 API 和 SDK 将 OpenShip 集成到您自己的工具中。从代码中读取资源、部署项目、检查运行状态以及管理授权工作流。

使用授权凭证和工作区上下文将客户端连接到预期实例。生成的参考将 SDK 方法映射到 HTTP 路由，并解释所需的功能和目标可用性。

使用操作 ID 和记录的进度或日志界面来进行长时间运行的工作。 API和SDK调用使用平台的权限检查；键入的请求不能替代对所涉及资源的访问。

## 类型化的客户

使用已发布的 TypeScript SDK 来执行受支持的操作。

## HTTP 参考

查找请求形式、权限要求和示例。

## 操作可视性

通过状态和进度界面跟踪长期运行的工作。

[阅读指南](https://openship.io/docs/api)
