Install API Connect

Install on Your Laptop

Install Node

Mac and Linux

If you haven’t already done so, install Node.js.

NOTE: API Connect supports the current Node.js long-term support (LTS) version, but we expect it to run on more recent Node versions as well, though they may not yet be officially supported.


Install version 3 of npm by entering the following command:

$ npm install -g npm

Then ensure the npm command uses the correct version:

$ npm -v

If the version shown is not 3.x.x, then edit your system PATH to ensure that C:\Users\username\AppData\Roaming\npm supersedes any other entries.

For more information, visit the knowledge center.

Install IBM API Connect (All Platforms)

$ npm install -g apiconnect

This installs:

  • API Connect Developer Toolkit, that includes the apic command-line tool and the API Designer visual tool
  • LoopBack Node.js framework
  • API Connect Micro Gateway
Create an API Connect Project

Create an API

Create a simple LoopBack application.

$ apic loopback
[?] What's the name of your application? my-notes
[?] Enter name of the directory to contain the project: my-notes
    create my-notes/
info change the working directory to my-notes
[?] What kind of application do you have in mind? (Use arrow keys)
  empty-server (An empty LoopBack API, without any configured models or datasources)
  hello-world (A project containing a controller, including a single vanilla Message 
  and a single remote method)
> notes (A project containing a basic working example, including a memory database) 
I'm all done. Running npm install for you to install the required dependencies. 
If this fails, try running the command yourself.

The tool displays a number of messages as it creates all the necessary files and directories for your API.

Open API Designer

Start the API Designer

Go to the project directory and start the API Designer.

$ cd my-notes
$ apic edit
Express server listening on

You’ll see the IBM Cloud login screen. Log in with your IBM Cloud ID and password. If you have not yet registered, register for IBM Cloud.

You’ll see the API Designer after logging in.

API Designer

Privacy Preference Center

Close your account?

Your account will be closed and all data will be permanently deleted and cannot be recovered. Are you sure?