For API syntax and tips, see the API Reference, which is generated from the Swagger specification.

This Getting Started guide covers:

Prerequisites

  • PAC Project 9.5
    • Download and install either PAC Project Pro or Basic
  • PAC Firmware 9.5
    • SNAP PAC R-series or S-series controller with firmware R9.5a or higher
    • Lastest firmware downloads are available here
  • Network access to your controller
  • Browser software

Top

Enable the REST API in PAC Manager

By default, PAC firmware R9.5 and higher have SSL encryption enabled, and the web server for the REST API is disabled. To use the REST API, you need to enable the web server and configure the port on which it will listen.

The are two options for connecting to the REST API:

Protocol Standard Port Description
HTTPS 443 Uses standard SSL encryption to secure the communication between the client software and the PAC. This is the default and recommended setting.
HTTP 80 Insecure access to the REST API.
In production environments, we strongly recommend HTTPS for secure, encrypted access to your controller.

Using PAC Manager’s Inspect tool:

  1. Click Communications, and choose Network Security from the pop-up menu.
  2. In the WEB SERVER section:
    1. Change the default value of TCP Listen Port. Typically, port 443 is used for HTTPS, and port 80 is used for HTTP.
    2. Verify the value of HTTPS.
      • For HTTPS, the value should be Enabled.
      • For HTTP, change the value to Disabled.
    3. Click Apply to save the changes. PAC Manager Network Security Settings
  3. On the left side of the Inspect window, click the Status Write button, and then, in the Operation area:
    1. Click “Store configuration to flash”, and then click Send Command.
    2. Click “Restart Device from powerup”, and then click Send Command.

Top

Next Step

Continue to Create Your API Admin User.