Documentation main page
API - Postman
- API - Postman
Download Postman (free)
FRINX uses the free Postman REST client as an API for the FRINX ODL distribution. Download Postman for your system
Download FRINX Postman collection and environment files
We have created collections of REST calls that form the API for the FRINX ODL distribution. These REST calls are grouped together as Postman collection files.
For some features we also provide Postman environment files (with suffix env.json). These make the REST calls easily configurable through the use of variables, whose values you can edit (see section below in importing).
Both the FRINX Postman collection and Postman environment files are grouped by FRINX ODL release (starting with 3.1.1) and packaged as zip files here.
On that page, find your FRINX ODL version number and click on ‘zip’ to download to a location on your local machine.
In a terminal on your local machine, unzip the file. This will create a new directory with the following subdirectories, grouped by FRINX ODL features:
Infrastructure- Bundle API, Clustering
L2VPN Service Module- L2VPN
L3VPN Service Module- L3VPN
Uniconfig Framework- CLI, Uniconfig
Importing FRINX Postman collection & environment files into Postman
Start Postman and click on Import near the top-left of the screen.
In the pop-up window which opens, click Choose files and navigate into the subdirectory of your choice (Infrastructure, L2VPN Service Module, L3VPN Service Module or Uniconfig Framework) and select a postman_collection.json file to import (both collection files and environment files are imported from here).
Imported Collection files appear as folders on the left of the screen. They contain sets of REST calls which allow you to interact with FRINX ODL and to use FRINX ODL to interact with network devices.
The advantage of setting environments is that you can re-use the same variable name throughout the URL and body of multiple calls, and update its value in one location.
You can create your own environments, but you can also make use of environments we have created to save time. You can re-use our keys, but you will need to update the values according to your setup:
Imported Environment files contain variables whose values you can update by clicking on the cog icon near the top-right of Postman and selecting Manage Environments.
All the environments you have imported or created will be listed:
CLick on the environment you wish to edit. You are then able to set values for each key (variable):
Click on Update to save your changes.
Activating an environment
Next you need to select your choice of environment from the drop-down menu in the top right of screen:
The value you set for each key when you configured the selected environment is substituted for the key wherever it appears within the body or URL of any REST call you issue while that environment is active. When using keys within calls, they should be encapsulated in double sets of curly braces (our postman collection calls are already set up this way):
Distinct versions of the FRINX Postman API files are available here, and named in the following format to correspond to analogous FRINX ODL distributions:
Between releases we also publish release candidate (RC) zip files in the same location which are pre-release versions in the development stage. These correspond with pre-release versions of FRINX ODL. The naming format is:
Backwards compatibility of FRINX Postman collections:
Infrastructure - Works with all releases of Carbon, Boron, Beryllium FRINX ODL
L2VPN Service Module - Works with all releases of Carbon, Boron FRINX ODL
L3VPN Service Module - Works with all releases of Carbon, Boron FRINX ODL
Uniconfig Framework - Works only with corresponding version of FRINX ODL