Postman Collection

A postman collection has been created to test out the most commonly used API’s for the directory.

Collection JSON

Here is the file that can be imported into Postman

 

Setting up the Authorization

Once you have downloaded and imported the Postman Collection you will need to set up the authorization variables to be able to get a access token.

Step One - Put in your auth settings

Go to the Social Services - Variables Tab which is shown below

For the following items put in the UAT information that was given to you by the Michigan 211 administrator

client_id - This is the client id for getting your OAuth2 token

client_secret - this is the client secret for getting the OAuth2 token

x-api-key - this is the api key for your API calls

Step Two - Get a Access token

Get a new access token to be used for making the postman calls. Go to the Social Services - Authorization tab and scroll to the bottom of the page and select Get New Access Token

After that you should now have a new access token that can be used for making calls

 

Step Three - Make a query call

Making a services query call. One thing to note here is that the query filter is a JSON object and needs to be encoded when making the call.

On the examples in the description of the query parameter is a example of the JSON for the query.

You can copy that JSON and put in the value column. You can then make the changes to the parameters such as taxonomy id or zipcode and then after that highlight all text and right click and select encodeURIparameter as shown below.

 

After that you should be able to click send and execute the API call