Integrating with a partner's API can be a complicated process. Here at Ultimate Software, we strive to make your integration with our services as seamless as possible. For this reason, we recommend that your team use Postman to experiment and test out our services prior to integrating within your own applications.
Note: It should be understood that we are only using Postman for UltiPro's REST API's and it is not used with SOAP services.
Collections will take your team's productivity to the next level. A collection lets you group individual requests together. These requests can be further organized into folders to accurately mirror your API. Requests can also store sample responses when saved in a collection. You can add metadata like name and description too so that all the information that a developer needs to use your API is available easily. Collections are listed in the sidebar alphabetically. You can search through collection requests using the search form for quick access. Our team is working to create Postman collections for registered users of UPC (UltiPro Connect). These collections can easily be shared between developers or teams and imported for quick use.
Collections are merely JSON documents and can be imported by:
- File upload
- Paste raw text
- Download from link
While working with APIs, you will often need to have different setups. For example, your local machine, the development server, or the production API. Environments give you the ability to customize requests using variables. This way you can easily switch between different setups without changing your requests. You won’t have to worry about remembering all those values once they are in Postman. Environments can be downloaded and saved as JSON files and uploaded later. Each environment is a set of key-value pairs. These can be edited using the key-value editor. The key is the variable or property name. This makes it really simple to have results from one API request populate the properties or access tokens for subsequent requests. All of this can be saved for ease of reuse.
Much like the collections, the environments can easily be shared between developers or teams and imported for quick use.