@acoustic-content/delivery-sdk 中文文档教程
Acoustic Content Delivery JavaScript SDK
Acoustic Content Delivery API 的官方 JavaScript SDK。
Motivation
此 SDK 旨在帮助在客户端和服务器端应用程序（无头）中利用 Acoustic Content 库中托管的内容。
Table of Contents
Getting Started
Prerequisites
建议安装最新版本的 Node.js 和 npm 以在应用程序中使用此 SDK。 要安装 Node.js，请按照 Node.js 网站上提供的官方文档进行操作。
Installing
此 SDK 可作为节点模块直接从 npm 注册表 安装。
Install using npm:
$ npm i @acoustic-content/delivery-sdk
Usage
API Reference and Documentation
此 SDK 基于在 Acoustic Developers 网站上完整记录的 Acoustic Content API 的交付端点。
此外，您可以使用 TypeDoc 使用命令生成文档：
npm run typedoc
How to Use?
要使用此 SDK，您需要先将库导入您的项目：
const ContentDeliverySDK = require("@acoustic-content/delivery-sdk");
Request for Assets
ContentDeliverySDK.create({
apiUrl: "",
})
.deliverySearch()
.assets()
.get()
.then((deliverySearchResult) => {
// some actions with documents
});
Request for Assets (with authorization)
如果您想将请求作为授权用户，请将用户名和密码添加到应用程序的配置中：
ContentDeliverySDK.create({
apiUrl: "",
username: "",
password: "",
})
.deliverySearch()
.contentItems()
.protectedContent()
.get();
您可以在 sample 文件夹。
Running the Tests
Install development dependencies:
$ npm i
Run Tests
package.json 中提供了运行测试的命令。
Unit test mode:
$ npm run test
Integration test mode:
$ API_URL=<url> USERNAME=<username> PASSWORD=<password> npm run test
Built With
License
此项目已获得 Apache License 2.0 许可 - 请参阅 LICENSE 文件了解详细信息
Acoustic Content Delivery JavaScript SDK
Official JavaScript SDK for the Acoustic Content Delivery API.
Motivation
This SDK is designed to help utilize the content hosted in Acoustic Content libraries in client and server-side applications (headlessly).
Table of Contents
Getting Started
Prerequisites
It is recommended to have the latest version of Node.js with npm installed to use this SDK in an application. To install Node.js, please follow the official documentation available on Node.js website.
Installing
This SDK is available for installation as a node module directly from the npm registry.
Install using npm:
$ npm i @acoustic-content/delivery-sdk
Usage
API Reference and Documentation
This SDK is based on the Acoustic Content API's delivery endpoints fully documented at Acoustic Developers website.
Additionally, you can generate the documentation with the use of TypeDoc by using a command:
npm run typedoc
How to Use?
To utilize this SDK, you need to import the library to your project first with:
const ContentDeliverySDK = require("@acoustic-content/delivery-sdk");
Request for Assets
ContentDeliverySDK.create({
apiUrl: "",
})
.deliverySearch()
.assets()
.get()
.then((deliverySearchResult) => {
// some actions with documents
});
Request for Assets (with authorization)
If you want to make a request as an authorized user, please add username and password to the application's configuration:
ContentDeliverySDK.create({
apiUrl: "",
username: "",
password: "",
})
.deliverySearch()
.contentItems()
.protectedContent()
.get();
You can find more examples in the sample folder.
Running the Tests
Install development dependencies:
$ npm i
Run Tests
Commands to run tests are provided in package.json.
Unit test mode:
$ npm run test
Integration test mode:
$ API_URL=<url> USERNAME=<username> PASSWORD=<password> npm run test
Built With
License
This project is licensed under the Apache License 2.0 - see the LICENSE file for details
