API Connect Developer Toolkit on Windows

September 2016
ryancox@us.ibm.com

The API Connect developer toolkit install, as described in the published install instructions below, failed
on three Windows machines for me. These are the steps that finally worked to get past the various issues
on these Windows versions:

• Windows 7 Professional 64-bit

• Windows 2008 64-bit

These instructions worked for my installation of the developer toolkit for API Connect v5.0.4.0.

Various Install Instructions

Installing your toolkit
http://www.ibm.com/support/knowledgecenter/SSMNED_5.0.0/com.ibm.apic.toolkit.doc/tapim_cli_install.h
tml

Getting Started
https://developer.ibm.com/apiconnect/getting-started/

My Install Steps

1) install Python 2.7.1.1

download -> https://www.python.org/download/releases/2.7/
install home: C:\app\Python27

2) install .NET Framework 2.0 Software Development Kit (SDK) (x86)

(On Windows 7 Professional 64-bit, I got a message saying that this was already installed as part of the
operating system)
download 64-bit version -> http://answers.microsoft.com/en-us/windows/forum/windows_7-
windows_programs/need-to-install-net-framework-20-on-windows7-64/29b7383f-0545-4d37-a8e4-
abd971eb325b?auth=1

3) install Node.js
download -> https://nodejs.org/en/download/
version: node-v4.6.0-x64.msi
install home: C:\app\nodejs

4) install Visual Studio Express 2013

download ->
https://www.microsoft.com/en-us/download/confirmation.aspx?id=44914
install home: C:\app\Microsoft Visual Studio 12.0

5) install OpenSSL 64-bit

(to get past the hard-coded path to the OpenSSL library: cannot open input file 'C:\OpenSSL-
Win64\lib\libeay32.lib' )
see post about this -> https://github.com/nodejs/node-gyp/wiki/Linking-to-OpenSSL
 download installer-> http://slproweb.com/products/Win32OpenSSL.html (Win64OpenSSL-1_0_2j.exe)
install home: C:\OpenSSL-Win64

6) open command prompt with admin privileges (right click > Run as administrator) and run all of the
following npm commands from here.

7) changed the prefix path for where node installs its node-modules.
(this shortens the default path is C:\Users\IBM_ADMIN\AppData\Roaming\npm which caused the api
connect install to fail because of windows path being too long - over 256 characters)
npm config set prefix=C:\app\nodejs\p
(this path is arbitrary; just needs to be something short)

8) add the new node prefix directory to the system PATH environment variable

9) install version 3.x of npm

(from https://developer.ibm.com/apiconnect/getting-started/)
npm install -g npm

Then ensure the npm command uses the correct version:

npm -v
(my response: 3.10.8)

10) uninstalled api connect cleanly from previous failed installations

from https://m.ibm.com/https/developer.ibm.com/answers/questions/274707/serious-installation-
issues-with-apiconnect-desegn.html?wirelessshow=2
npm rm apiconnect -g --cache-clear

11) install API Connect

npm install -g apiconnect
install location: C:\app\nodejs\p\apic (this location is determined by the node prefix directory set in step
7)

To check version of API Connect installed:

apic -v(my response: API Connect: v5.0.4.0 (apiconnect: v2.3.6))

12) all apic commands must be run from the command prompt with admin privileges. if you don't do this, the
micro gateway will not start up when running the node apps locally.
this is mentioned on this page ->
http://www.ibm.com/support/knowledgecenter/SSMNED_5.0.0/com.ibm.apic.toolkit.doc/tapim_cli_inst
all.html
at the bottom for "Windows": If you encounter permissions errors running commands, and you installed
the Toolkit using an account with administrator privileges, then you need to run CLI commands with
administrator privileges as well.