LogoLogo
5.2
  • Docs
  • Connector Configuration
  • Knowledge Base
  • Changelog
5.2
  • Introduction
  • Migration from 5.1
  • Overview
    • Introduction
    • Component
    • Flow
    • End User Guide
  • Component Definition
    • Basic Structure
    • Manifest
      • name
      • label
      • icon
      • marker
      • author
      • description
      • auth
      • authConfig
      • quota
      • properties
      • inPorts
      • outPorts
      • firePatterns
      • tick
      • private
      • webhook
      • state
      • localization
    • Behaviour
    • Dependencies
    • Authentication
    • Quotas & Limits
    • Configuration
    • Example Component
  • Customizing UI
    • Custom Inspector Fields
    • Custom Theme
    • Custom Strings
    • Custom API
    • Custom Component Strings
    • Custom Component Shapes
    • Custom Auth Popups
  • Appmixer hosted
    • Getting started
    • Creating Custom Components
    • Using Appmixer SDK
    • Using Appmixer API
    • Using Oauth applications
  • Appmixer Self-Managed
    • Installation
    • Getting Started
    • Custom Component: HelloAppmixer
    • Using Appmixer SDK
    • Using Appmixer API
    • Using OAuth applications
    • Installation GCP
    • System Webhooks
    • Configuration
    • Appmixer Architecture
    • Appmixer Deployment Models
    • System Plugins
  • API
    • ACL
    • Accounts
    • Apps
    • Authentication
    • Charts
    • Config
    • Data Stores
    • Files
    • Flows
    • Insights
    • Modifiers
    • People Task
    • Public Files
    • Service Configuration
    • Unprocessed Messages
    • User
    • Variables
  • Appmixer SDK
    • Introduction
    • Installation
    • Quick Start
    • Constructor
    • API Module
    • UI & Widgets
      • Flow Manager
      • Designer
      • Insights Logs
      • Insights Chart Editor
      • Insights Dashboard
      • Accounts
      • Storage
      • People Tasks
      • Connectors
      • Integrations
      • Wizard
    • Developer mode
  • Appmixer Backoffice
    • Getting Started
    • Services
    • Quotas
    • Public Files
    • System Configuration
    • Modules
  • Tutorials
    • Managing Authentication
    • Sharing Flows
    • Flows Metadata & Filtering
    • People Tasks
    • Customizing modifiers
    • Setting ACL
    • Integration Templates
    • Installing and updating modules
    • Custom Webhook Trigger
    • Appmixer Virtual Users
    • Working with outport schemas
  • Appmixer CLI
    • Appmixer CLI
    • Appmixer OpenAPI Generator
      • Getting started
      • Open API Extensions
      • Examples
  • App Registration
    • Airtable
    • Azure Cognitive Services
    • Blackboard
    • DeepAI
    • DocuSign
    • Google
    • Highrise
    • Hubspot
    • Microsoft
    • Microsoft Dynamics 365 CRM
    • Quickbooks
    • Redmine
    • Salesforce
    • Schoology
    • Screenshot API
    • ServiceNow
    • Slack
    • Trello
    • Typeform
    • Utilities
      • Email
      • Language
      • Tasks
      • Test
      • Weather
    • Xero
    • Zendesk Tickets
    • Zoho
  • Connectors
    • Connector Request
Powered by GitBook
On this page
  • Configuration
  • Instance
  • Basic Usage

Was this helpful?

Export as PDF
  1. Appmixer SDK

Constructor

Appmixer Constructor lays a foundation for building user interfaces with widgets.

Configuration

Set up a new appmixer instance with config parameters and set/get methods:

const appmixer = new Appmixer({/* [name]: value */})

appmixer.set(name, value)
appmixer.get(name)

config.baseUrl

Type: String | Default: null

Base URL of your Appmixer engine REST API.

config.accessToken

Type: String | Default: null

Access token of an authorized user.

config.debug

Type: Boolean | Default: false

Enable debugger for development purposes.

config.theme

Type: Object | Default: DefaultTheme

config.l10n

Type: Object | Default: DefaultL10N

Define custom localization texts.

config.lang

Type: String | Default: en

Specify a language code for the localization of components.

config.api

Type: Object | Default: {}

Set custom API methods.

Instance

appmixer.ui

appmixer.ui('Widget', {/* ... */})
appmixer.ui.Widget({/* ... */})

Register and create UI Widgets.

appmixer.api

Use methods of built-in API Module.

appmixer.set

appmixer.set(key, value)

Set configuration property.

appmixer.get

appmixer.get(key, value)

Get configuration property.

appmixer.registerCustomComponentShape

appmixer.registerCustomComponentShape(name, shape)

Register a custom Designer component shape.

appmixer.registerInspectorField

appmixer.registerInspectorField(type, Field, options)

Register a custom Designer inspector field.

Basic Usage

Connect to Appmixer engine REST API and render user interfaces with a built-in widget:

<html lang="en">
<head>
  <meta charset="UTF-8">
  <script src="https://my.YOURTENANT.appmixer.cloud/appmixer/appmixer.js"></script>
</head>
<body>
  <div id="your-widget"></div>

  <script async type="module">
    const appmixer = new Appmixer({ baseUrl: BASE_URL })

    const auth = await appmixer.api.signupUser(USERNAME, PASSWORD)
    appmixer.set('accessToken', auth.token)

    appmixer.ui.FlowManager({ el: '#your-widget' }).open()
  </script>
</body>
</html>

Change USERNAME and PASSWORD parameters to valid credentials for registration of a new user.

Learn more about the basic usage with the Quick Start example.

PreviousQuick StartNextAPI Module

Last updated 1 year ago

Was this helpful?

Flow Manager