Skip to main content

Setup the IDE Extension

In this step you will set up your Twinit IDE Extension to connect to the Twinit Sandbox environment. The extension allows you to create scripts and user configs directly on the Twinit platform, as well as execute scripts using the various platform apis provided in the @dtplatform/platform-api and @dtplatform/iaf-script-engine javascript sdk modules. The majority of the training materials will rely on using the Twinit IDE Extension.

Generate Your API Keys#

The first thing you will need is to generate your user access keys. You will use these keys to configure the Twinit IDE extension to connect to the Twinit Sandbox environment.

  1. Sign in to your Twinit Sandbox user account by pointing your browser to https://sandbox-api.invicara.com/passportsvc/api/accounts
  2. Click the 'User Access Keys' option under 'Authenticator and Access'
  3. Click the 'Generate New Access Keys' button and save and record your Access and Secret keys.

Open the Twinit IDE Extension settings#

  1. In your IDE go to File > Preferences > Settings
  2. In the search field at the top of the setting search for 'twinit'
  3. Under Twinit-dev > Config: Applications click 'Edit in settings.json' This opens all the extension settings. Next we will add a Twinit environment.

Add the Twinit Sandbox environment#

Add or replace the Twinit-dev.config.environments with the one below.

You may add to this list of environments by adding additional configs in the array.

env: the url to the Twinit platform api for an environment (not where the client is hosted)

name: the name you wish to give this to the environment so you know what it is

access: the user access key

secret: the user secret key

"Twinit-dev.config.environments": [   {      "env": "https://sandbox-api.invicara.com",      "name": "Twinit Sandbox",      "access": <ADD YOUR ACCESS KEY YOU GENERATED HERE>,      "secret": <ADD YOUR SECRET KEY YOU GENERATED HERE>   }
],

Save and close the settings.json file.

Signin to the Twinit Sandbox Environment in the Extension#

  1. Save and close your modified settings
  2. Open the Explorer pane in vscode
  3. Expand the TWINIT-DEV panel in the Explorer pane
  4. Click the three dot menu to the right of TWINIT-DEV
  5. From the menu click TWINIT: Signin
  6. Select the Twinit Sandbox environment
  7. Select the Twinit Academy application
    • If you only have one application configured you may not see this step

You will see the Twinit Academy app tree appear in the extension panel.

You are now signed in to the Twinit Sandbox environment and your Twinit Academy application.

Troubleshooting#

If you do not see a Twinit Academy Application when you sign in Twinit Sandbox, please log a support ticket here: https://support.twinit.com/support/home