Skip to main content

Client SDK, a part of Aurora Platform API, is a client-side JavaScript library for building web applications with Aurora's latest computer-aided design technology.

Load Client SDK, attach to the DOM, and load a design. The latest build is located at https://aurora-sdk.s3.amazonaws.com/client-sdk-loader.next.js.

Browser Support#

We currently support the latest versions of Chrome and the latest versions of mobile Safari on iPads. Please reach out to your Aurora Account Executive if you have a need for additional browser support.

Script Tag#

<!DOCTYPE html>
<html style="height: 100%; width: 100%">
<head>
<title>Aurora Solar Client SDK Demo</title>
</head>
<body style="height: 100%; width: 100%">
<h3>My Aurora Solar Client SDK Demo</h3>
<!--The div element for the Aurora CAD view -->
<div style="height: 100%; width: 100%" id="cad-element"></div>
<script type="module">
const library = await import(
'https://aurora-sdk.s3.amazonaws.com/client-sdk-loader.next.js'
);
const sdk = await library.load({
username: '<USER>',
password: '<PASSWORD>',
});
console.log('SDK loaded', sdk);
// Saving to window for testing
window.sdk = sdk;
sdk.cad.attach('#cad-element');
// Saving to window for testing
window.design = await sdk.design.load('<DESIGN_ID>');
</script>
</body>
</html>