@inweb/client
v25.12.1
Published
JavaScript REST API client for the Open Cloud Server
Downloads
1,383
Maintainers
izavyalovReadme
Client.js
Client.js is a JavaScript library implementing the REST API client for Open Cloud Server.
Core capabilities:
- Register on the server as a new user.
- Create new and manage existing user accounts.
- Upload and download files from the server.
- Manage existing files, upload new version of files.
- Convert files from one format to another.
- Run validation, clash detection, and custom jobs on the server.
- Create and manage assemblies.
- Create projects, manage project models and members.
- Change server settings.
This library is a part of CDE SDK by Open Design Alliance.
Installation
CDN or static hosting
For CDN, you can use unpkg or jsDelivr (replace 25.3 with a version you need):
<script src="https://unpkg.com/@inweb/[email protected]/dist/client.js"></script>The global namespace for Client.js is ODA.Api.
<script>
const client = new ODA.Api.Client({ serverUrl: "https://cloud.opendesign.com/api" });
</script>Install via npm
Open a terminal in your project folder and run:
npm install @inweb/clientThe Client.js package will be downloaded and installed. Then you're ready to import it in your code:
import { Client } from "@inweb/client";
const client = new Client({ serverUrl: "https://cloud.opendesign.com/api" });Example
Login to the Open Cloud Server and get the file list from the server:
<html>
<body>
<script src="https://unpkg.com/@inweb/[email protected]/dist/client.js"></script>
<script>
const client = new ODA.Api.Client({ serverUrl: "https://cloud.opendesign.com/api" });
client
.signInWithEmail("email", "password")
.then(() => client.getFiles())
.then((files) => files.result.map((file) => file.name))
.then((names) => console.log(names));
</script>
</body>
</html>To learn more, see First application guide.
Copyright and license
Code and documentation copyright 2002-2024 the Open Design Alliance. Code is distributed under a proprietary license, see LICENSE for more information.