Postman Collection
Requests ready to be used in one of the more common formats: Postman
During development of fulfillmenttools as an API-First product the design, documentation and testing of the APIs are taking a high priority. Therefore a wholesome Postman Collection is in use and frequently updated with new Requests as they appear in the API.
This page shares this resource to developers or other technical personnel in order to ease the access to the fulfillmenttools RESTful API and share concrete examples.
Available resources
Postman divides its functionality into several categories such as Collections, Environments, Mock Servers, etc.. For documentation purpose fulfillmenttools provides a template Environment and the Collection of calls towards fulfillmenttools RESTful API. In order to work with the Collection you need to import the Environment into Postman and fill in the data as described below.
Step 1 (optional): Import fulfillmenttools Environment into Postman
The Environment contains a set of variables that tells Postman where to address certain calls and which data should be used. If you want to try out an existing fulfillmenttools system using our Postman Collection it is recommended to import and setup an Environment.
In case you just want to get a glimpse at the calls you do not necessarily need to setup an Environment.
Use this link to download the template Environment file and import it into Postman (see Postman documentation here).
These are the variables that are presented to you afterwards which you need to fill:
| Variable | Description | Example Value |
|---|---|---|
| The Host of your fulfillmenttools platform environment |
|
| The apiKey to our IdentityProvider to generate a AuthToken |
|
| The login of a user, that exists in the system, usually in the form of an email. Please include the host part of the login. | user@ocff-your-prd.com |
| The password of the user. |
When using Postman more variables will occur in the Environment. Be advised, that especially authTokens & refreshTokens will be stored in the Environment of the Postman Instance you are using.
Step 2: Import fulfillmenttools API Collection into Postman
Similar to setting up an environment you can import the Collection of Requests into Postman. Please use this link to download the needed file & import it into Postman as described here.
fulfillmenttools API and thus the Collection of calls is constantly growing. Therefore it is a good idea to update your Collection of calls every now an then to stay up to date with the latest changes.
Once you successfully imported the call Collection you are presented with a view similar to this:
Step 3: Make your first API Call using Postman
The documentation on how to Make your first API Call says we need to issue at least two calls in order to communicate with the API: First, we need to get an Auth Token and then use this Auth Token in our call towards the fulfillmenttools API. Let's do exactly this using Postman:
After the call has successfully been executed the response is received from the IdentityProvider containing (among other data) the actual authToken and a refreshToken which are used for calls against the fulfillmenttools API.
Both values are stored as environment variables - you do not need to copy those!
Now we can execute every call in the Collection - in this example we will request the list of facilities:
Have fun!
Now you are good to go to adapt and execute the other calls or create new requests.
Last updated
