Using Postman

Introduction

Postman is a popular API client that is designed to make it simpler for developers to create, share, test & APIs. This is done by letting users create and save simple and complex HTTP/s requests, as well as read their responses. This results in a more efficient and less tedious work process.

Steps:

1. Download Postman at https://www.postman.com/. The setup process is very straightforward on all operating systems.

2. Create an API Key for the user. For steps on creating an API key: https://teaminstant.visualstudio.com/Chime-Public/_wiki/wikis/Chime-Public.wiki/181/Chime-Reporting-API

3. Enter a Chime report API route:

4. Add Query String Parameters:

5. Add the API key to Authorization Headers:

• For additional information on how to obtain an API key please use the following link: https://teaminstant.visualstudio.com/Chime-Public/_wiki/wikis/Chime-Public.wiki/181/Chime-Reporting-API

6. Press send and receive some data:

Trouble Shooting:

1. HTTP Status 400 BAD REQUEST: [12:49 PM] Seamus Murphy

Ensure that the query string parameters have been included. 2. HTTP Status 403 FORBIDDEN: Ensure that the API key is current and to preface it with "Bearer"