Node API Setup

Setting up the Node API.

Enterprise (and Connect) Server v3.0+ features the Node API, which is a daemon that offers REST-inspired file operations and a transfer management API. The Node API has the following functionality:

Provides an HTTPS (by default port 9092) and HTTP (by default port 9091) interface.
API encoded in JSON.
API is authenticated and the node daemon uses its own application-level users (i.e., "node users").
Features a node admin utility called “asnodeadmin,” which can be utilized to add and manage "node users."
Logs to C:\Program Files\Aspera\Enterprise Server\var\log or C:\Program Files (x86)\Aspera\Enterprise Server\var\log.

You can use the Node API to set up the following configurations:

Set up a remote transfer server for Aspera Faspex. In this configuration, the Aspera Faspex Web UI is on Machine A, while the transfer server (an Enterprise Server node) is on Machine B. Machine A communicates with Machine B over HTTPS, by default.
Set up nodes for Aspera Shares. In this configuration, the Aspera Shares Web UI is on Machine A, while content nodes (Enterprise Server nodes) are created on Machines B, C and D. Users can then be granted permission to access specific directories (i.e. shares) on nodes B, C and D.

To set up the Aspera Node API, follow the instructions below. These instructions assumed that you have already installed Enterprise (or Connect) Server 3.0+.

Create a Node API username.
Aspera's Web applications authenticate to the remote node service using a Node API username and password. The following command creates a Node API user/password and associates it with a file transfer user, asp1, which you will create in the next step. The Node API credentials can then be used to create nodes. Note that different nodes may use different Node API username/password pairs.
```
> asnodeadmin.exe -a -u node_api_username -p node_api_passwd -x asp1 
```
Note that adding, modifying, or deleting a node-user triggers automatic reloading of the configuration and license files, as well as the user database.
Create a file transfer user.

The file transfer user authenticates the actual ascp transfer, and must be an operating system account on the node. Create a transfer user—for example, asp1—on your operating system (Control Panel > User Accounts). (Creating a user account requires administrator permissions.)

Note: After creating a Windows user account, log in as that user as least once in order for Windows to set up the user's home folder—for example, C:\Users\asp1. Once the user's home folder has been created, log back in as an administrator and continue the steps below.

After you've created the operating system account, set up this user in Connect Server. For instructions on setting up a user, see .

Note: The file transfer user requires a docroot. After setting a user's docroot, be sure to perform a reload, as described in aspera.conf for Nodes.

CAUTION:
Aspera recommends that you not use spaces in your docroot. If your docroot contains spaces, you may not receive all email notifications relating to transfer activity.
(Optional) Change HTTPS port and/or SSL certificate.

The Aspera Node API provides an HTTPS interface for encrypted communication between node machines (on port 9092, by default). To modify the HTTPS port, see aspera.conf for Nodes. For information on maintaining and generating a new SSL certificate, see Setting up SSL for your Node(s).