Get started with our application framework!
The Zywave API Toolkit is offered in a variety of ways. All components (including the bundle) are available via the npm registry; meaning you're just an npm install or yarn add away.
However, the most common (and recommended) way to install the toolkit is via a CDN that can resolve npm tags and versions. Zywave offers that service via the Zywave CDN.
Installing the bundle via CDN
The Zywave API toolkit offers a bundle with all of the core componentry for the Zywave API Toolkit, including Zywave Shell, the API proxy, etc. This bundle is delivered as an ES module, and only works in modern browsers.
By loading the bundle via a CDN that can resolve npm tags, we can push fixes/enhancements to your application without any deploy on your end.
<script type="module" src="https://cdn.zywave.com/@zywave/zywave-api-toolkit-bundle@{latest|next}/dist/bundle.js"></script>
latest/next
You may have noticed in that code snippet above the following:@{latest|next}
These terms correspond to npm distribution tags, where latest is stable, production-ready code, and next is generally unstable and not suitable to be referenced in a live environment.
Choose the right tag for your situation, and update accordingly (e.g. https://cdn.zywave.com/@zywave/zywave-api-toolkit-bundle@latest/dist/bundle.js)
Version numbers
In addition to dist tags, you can use any valid npm version as found here.
This can be generally useful when a critical issue is encountered, or a deprecation notice goes unheeded.
A versioned URL could look something like the following:https://cdn.zywave.com/@zywave/zywave-api-toolkit-bundle@1.0.22/dist/bundle.js
API Proxy Element
The Zywave API Toolkit, as its name might suggest, communicates with Zywave's own APIs via client-side JavaScript. Because of distrust when it comes to client-side authentication, we offer an API Proxy element that communicates API calls through a hosted proxy application, which applies secure headers before sending the request off to the underlying APIs. This element must be the first element on the page within your <body> and requires an api-base-url be supplied to ensure it is pointing at the proper host.
Note: the API proxy element can only be used by a user authenticated with Zywave SSO and at a *.zywave.com subdomain. If this doesn't apply to you, then you will be required to provide a profile-token or bearer-token to all Zywave API Toolkit components.
For more information on the API Proxy Element, click here.