Setting up Postman with Streak's API
Postman is a great way to explore the Streak API and get more comfortable with what's possible using it. If this is your first time using an API or Postman, this article will walk you through setting up Postman and sending your first few requests to the Streak API.
If you haven't already, you'll need to download and install Postman to follow along.
Configuration and set-up
After installation and launching, you'll be greeted with the following window:
We'll be establishing a few basic requests in this guide, so let's start with a Collection in Postman. This will allow you to organize your requests around a single authorization and simplify things down the road.
After filling in the title and description of a Collection, head over to the next tab: Authorization.
For Streak's API, we use API keys for authorization and access, which means you'll need to use Basic Auth as your Authorization Type and your API key as the Username. If you don't have it already, you can get your API key from the Integrations page of the Streak application.
The tab should look something like this:
After tapping Create you should be all set to use the Streak API.
Sending your first request
Now that you've completed set-up, we can send a request to a Streak API endpoint to verify that it's working.
From the left column of Postman, you'll see your new collection with the option to Add requests to it. Click that button and fill in the details to save your request:
With that filled out, click Save to Streak API. You'll be brought back to the same screen before. Tap your new request and select Open in builder.
This request can be to any end point in the Streak API (you'll find a reference in our API documentation), but for now we'll be sending a
GET request to the
https://www.streak.com/api/v1/users/me endpoint. Remember that your type of request needs to match what our API expects – a
GET request for an end point expecting a
POST can lead to some unintended results and consequences.
Your request should return JSON in the body beneath the builder:
If you're not seeing a result similar to what's above, please make sure your authorization settings in the collection are accurate and the request your sending matches the instructions above.
When you're done, press the Save button toward the top right of the application. You've sent your first request to the Streak API!
Now that you're set up with Postman, you should feel free to experiment with requests in our documentation. We've also assembled a small collection of Streak requests for Postman that you can download here and will help you take your next steps developing with Streak.