The Elfsquad Configurator Library allows you to easily interact with the Configurator API.
authenticationMethod(optional) Authentication method required by the application. Defaults toANONYMOUS.tenantIdIdentifier of the tenant. The tenant id can be found on the integrations page of your EMS.authenticationOptions(optional) See Elfsquad Authentication Library for the available options. This setting is required when the authenticationMethod isUSER_LOGINorANONYMOUS_AND_USER_LOGIN.apiUrl(optional) Base address of the Elfsquad API. Defaults tohttps://api.elfsquad.io.
getConfigurationModelsRetrieves a list of all available configuration models.newConfigurationStarts a new configuration session.openConfigurationOpen an existing configuration.getLayout3dRetrieves the 3D layout settings for the configuration session.getSettingsRetrieves the configurator settings.
updateRequirementUpdate the value of a feature in the configuration session.updateTextUpdate the text value of a feature in the configuration session.changeLanguageChanges the language of the texts in the configuration session.getStepImageRetrieves the step image for a step in the configuration session.getPdfGenerates a PDF document for the configuration session.
const TENANT_ID = 'ff0a9727-ced1-4b99-9f8a-2087a1f79ba4';
const configuratorContext = new ConfiguratorContext({
tenantId: TENANT_ID
});
configuratorContext.getSettings().then((settings) => {
console.log('settings', settings);
});
configuratorContext.getConfigurationModels().then((models) => {
console.log('models', models);
let model = models.features[0];
configuratorContext.newConfiguration(model.name).then((configuration) => {
console.log('newConfiguration', configuration);
configuratorContext.openConfiguration(configuration.id).then((openedConfiguration) => {
console.log('openedConfiguration', openedConfiguration);
const feature = openedConfiguration.steps[0].features[0];
configurator.updateRequirement(feature.id, true, 1).then((updateResult) => {
console.log('updateResult', updateResult);
});
configurator.updateText(feature.id, 'test 123').then((updateResult) => {
console.log('updateTextResult', updateResult);
});
configurator.changeLanguage(Object.keys(models.languages)[2]).then((updateResult) => {
console.log('changeLanguage', updateResult);
});
configurator.getStepImage(openedConfiguration.steps[0].id).then((image) => {
console.log('image', image);
});
configurator.getPdf().then((pdf) => {
console.log('pdf', pdf);
});
configuratorContext.getLayout3d().then((layout) => {
console.log('layout', layout);
});
});
});
});