IDE: Getting Started

Navigation to IDE Instance Manager

• 1) User clicks on ‘Secure Experimentation Sandbox/IDE’ in Sandbox from Mega Menu to come to the IDE Instance Manager page.
• 2) User will be redirected to the IDE instance creation form by clicking on the ‘Create IDE Instance’ button.
• 3) The user will be able to search for IDE instances he has created using the search bar.
• 4) The user will be able to sort the IDE instances by Recently added, Oldest First, A-Z, Z-A.
• 5) The user will be able to filter the IDE list by status: ALL – Default, RUNNING, TERMINATED
• 

  1

Creating an IDE Instance

• 1) Upon navigating to 'Create IDE Instance', the user can enter the IDE name, URL (mapping name), Description and the Password and proceed to 'Create' in order to create a new IDE instance.
• 

  1
• 2) Upon creating the instance, the user will see a confirmation pop up where the user can click on 'Create and Launch' to complete the process of creating the instance.
• 

  1

Managing an IDE Instance

• 1) Once the version has been created successfully, it will show up in the instance grid displaying the Instance name, Description, Status, Creation Date/Time and Termination Date/Time
• 

  1
• 2) User will be able to view IDE Instance password by clicking on the view icon
  The user can also copy the password to clipboard.
• 

  1
• 3) To launch the IDE, the user can click the launch icon or the IDE name in the grid. Then the user will be prompted to enter the password that was used to create the instance. Once the password is added, the user can navigate to ‘Open IDE’ and begin the experimentation journey.
• 

  1
• 4) User may choose to ‘Delete’ or ‘Terminate’ the Running instance. To terminate the running instance user may click on the terminate icon .
  Upon terminating the user will see the confirmation pop up below.
• 

  1
• 5) Once the user confirms the termination of an IDE instance, the user will see the status of the instance changed from ‘Running’ to ‘Terminated’. The time of termination will also be displayed. The user will no longer be able to view or access this IDE instance.
• 6) The user will be able to delete a running or terminated instance by clicking on delete icon
  Upon deleting the user will see the confirmation pop up below.
• 

  1

IDE Experimentation

After creating an IDE instance, the user will be able to start the experimenting journey

This Visual Code Plugin is designed to accelerate the innovation with the APIs published in APIX.

• Plugin can be used for Node.js only
• All the subscribed APIs, versions, endpoint details can be accessed through the plugin.
• Plugin will generate code to try out the endpoints.
• 

  1

Installation steps

Latest Version: 1.0.5

• 1) Download the latest plugin bundle here
• 2) Open Visual Code
• 3) Go to View Menu > Extensions
• 4) Select More Actions > Install from VSIX > Select downloaded latest plugin bundle > Install
• 

  1

Create a Node.js project [OPTIONAL]

• 1) Download and install Node.js from official website
• 2) Open Terminal application
• 3) Browse to your preferred path to store your Node.js project

• cd ~/Desktop

• 4) Execute below command and provide the project details.

• npm init

Configure Node.js Project to use IDE

• 1) Open your Node.js project in Visual Code
• 2) Open New Terminal window from Terminal menu.
• 3) Execute below command to install swagger-client npm dependency.

• npm install --save swagger-client

• 4) Open APIX IDE Extension
• 5) Click on Configure button. apix.json file will be opened.
• 6) Provide domain, username, password information in apix.json file and save. File will be saved to the project root folder.
• 

  1
• 7) Click Refresh button in the APIX IDE Extension.
• 8) If the provided credentials in the apix.json is correct and if you have any API subscriptions in APIX, subscribed API list should get listed now.

Using extension to try-out APIs

• View a code Example

  • Click on Add index.js button which will create a index.js file with an example in your Node.js project.
  • 

    1

  • Generated Code Sample is as below.

  • 

    1

• Generate Code for an API endpoint

  1. Open the file and put the cursor to the place where you want to insert the generated code.
  2. Expand the API > Version > Endpoint and select the method to generate the code.
  3. Click on the arrow next to the method to generate the code.
     • 

       1
  4. Code will be generated and added to the working document where the cursor is.
     • 

       1
  5. Change the generated code with header, query, body, path parameter values..
  6. Save the file.
  7. Run code with below command.

     node <filename>
     ex:
     node index.js

• Generate Code for APIX Token generation

  1. Open the file and put the cursor to the place where you want to insert the generated code.
  2. Go to the APIX IDE Extension
  3. Click on the Key icon in the toolbar.
     • 

       1
  4. Code to get the APIX token will be generated and added to the working document where the cursor is.
     • 

       1

  5. Now you are all set to continue working on this APIX IDE.