Skip to main content

Installation

There are two ways to install Shakr SDK - either by using the NPM package or by adding the <script> tag to your HTML file directly.

Using NPM Package​

npm install @shakrmedia/editor-sdk
// Use Video Editor SDK
import { createShakrEditor } from '@shakrmedia/editor-sdk';

const editor = await createShakrEditor({
  access_token: 'SCOPED_ACCESS_TOKEN',
  render_session_id: 'RENDER_SESSION_ID',
  ...
});
// Use Template Editor SDK
import { createShakrreadyEditor } from '@shakrmedia/editor-sdk';

const editor = await createShakrreadyEditor({
  access_token: 'SCOPED_ACCESS_TOKEN',
  template_style_version_id: 'TEMPLATE_STYLE_VERSION_ID'
});

Loading the <script> tag​

<script src="https://sdk.shakr.com/sdk.js" defer></script>
// Use Video Editor SDK
createShakrEditor({
  access_token: 'ACCESS_TOKEN',
  render_session_id: 'RENDER_SESSION_ID'
}).then(function(editor) {
  // Use the editor instance
});
// Use Template Editor SDK
createShakrreadyEditor({
  template_style_version_id: 'TEMPLATE_STYLE_VERSION_ID',
  access_token: 'ACCESS_TOKEN'
}).then(shakrready_editor => {
  // Use the shakrready_editor instance
});