Prerequisites

1. Have postman installed and running 

   1. Find installation guide for postman  here

2. Have access to the OpenSRP APIs postman collection url (opensrp-server-configs/assets/postman/OpenSRP.postman_collection.json at master · opensrp/opensrp-server-configs )
   NB - any updates on the postman collection changes the postman collection url

Steps for loading the collection

1. Launch postman (can run on all OS platforms)

2. Click Import, then Import from the link.

Open

3. Copy and paste the OpenSRP APIs postman collection link (in the field “Enter a url and press Import”)

Changing global settings steps

1. Go to the OpenSRP collection and click on the 3dots(...), then choose Edit

Open

2. Click on Variables

3. Change the current value of base_url to the base url of your OpenSRP APIs e.g for a sample url “https://anc-stage.smartregister.org/opensrp/security/authenticate” , the base url will be “anc-stage.smartregister.org” 

4. Change the current value of username to your OpenSRP API user name

5. Change the current value of password to your OpenSRP API password

You are now fit to run the tests.

Configuring Postman for OAuth with Keycloak

Note: replace parts marked with {{}} with the actual values

1. Get OpenID configuration settings from this endpoint
{{keycloak-url}}/auth/realms/master/.well-known/openid-configuration

2. Configure these variables in Postman as described in (2) above.

3. In Postman under request Authorization tab, select OAuth 2.0 in the TYPE drop-down. This will make available controls to configure and request for a new OAuth token from the server.

4. Click on Get New Access Token. This will show a form to configure OAuth details. Fill the fields as shown below. Values inside {{}} are parameters as defined in step (2) above.

5. For Auth URL and Access Token URL, replace master in the URL with the name of the realm. See section defined with {{realm}} in the URL

6. If all values are configured correctly, clicking on Request Token should fetch and display an token in the popup window.

7. Click Use Token to use the new token to access the API.

Proceed to set up the Headers and Body tabs for a request (in the collection), if necessary,
and click SEND to make a request using the Oath2.0 authorization.

*Oauth2.0 Authorization can also be set for each individual request, also under the Authorization tab, for situations where you may a request’s auth to be different from the one set for the collection.

Switching between Environments.

For scenarios where you may be working with multiple servers that share the same collection, you can easily switch between environments variables as described in the diagrams below.

In this case we were initially on the unicef-tunisia-stage, but easily switched to path-zeir-stage

Related articles