Using the Postman Test Collection

This tutorial demonstrates how to work with the supplied Postman test collection to test the setup of your yuuvis® Core API.

Requirements


Having completed the cluster setup, we can move on to testing our installation to see if everything is working properly. For this purpose, a Postman Collection containing Momentum's major endpoints has been prepared.

Import the test collection in Postman by opening the import dialog (CTRL+O or via the Collections tab on the left-hand side of Postman) and drag the "yuuvis® Momentum Postman Collection.postman_collection.json" file into the designated area.

Configure the environment of the Postman collection by adding values to the provided variable structure.

Select the imported environment and configure it for connections to the cluster. Since all calls to the Core API must travel via the authentication service, we configure the ip environment variable with the URL of the authentication service as its value. Both "initial value" and "current value" are to be filled in with that URL.


For all requests: In the 'Authorization' tab configure the authentication type "Basic Auth" with user name "root" and password "optimal" to ensure the test requests will pass through the authentication service. Depending on the authentication service configuration, this may or may not be required.


For POST requests: Add the payload files to the body of the request. Each test will provide some form of description which will point out what files to select. After a successful POST call, the API will return the objectId of the newly created object. This objectId can be used for upcoming tests requiring an object ID as a URL parameter.

For GET requests: Configure the objectId variable in the imported environment and set its value to the object ID returned by one of the successful POST tests.