Postman Project
Postman is a collaboration platform for building APIs. You can use Postman to design, build, and test APIs along with colleagues. Cytomic Orion uses Postman to enable and speed up the adoption of this technology by developers
The Cytomic Orion API is available as a Postman project for all clients and enables them to make calls from this environment and view the results without having to write a single line of code.
You can download and install Postman from https://www.getpostman.com/.
To send requests to the Cytomic Orion API from Postman:
-
Download file
Postman.Orion.API.zip
from https://info.cytomicmodel.com/resources/guides/Orion/en/Postman.Orion.API.zip and extract it to your desktop. -
Open Postman and import the files
APIOrion.postman_collection.json
andAPIOrion.postman_environment.json
. To do this, select File and Import. -
Generate a new application in the Cytomic Orion console (see Enable Access to the API from External Programs). Save the user name and password.
-
Click the
icon in the upper-right corner of the Postman page. Copy the user name and password from the previous step in the
username
andpassword
fields of the CURRENT VALUE column. -
If it is the first time you send a request in the session, run the
Authentication API
method in the Authentication branch to get an access token and a refresh token. -
In the 1.0 branch in the Postman left panel, select the API call you want to make. Click Send. The program creates the correct HTTP request based on the API specification and the provided parameters, and shows the server response along with the HTTP code that indicates whether or not it was successful.