Getting started with the Wildfire API Postman collection

Wildfire Systems maintains documentation for our APIs via Postman's hosted service as well as a Postman collection that makes exploring the REST APIs easy. In particular, the Postman collection includes a pre-request script that makes generating the auth headers automatic.

You can download/access the Postman collection via one of the following links, depending on your preference:

You can also download the desktop Postman client if you don't yet have it.

Once you have the collection open, you'll notice two folders contained within it: Client Endpoints and Admin Endpoints. With Wildfire, applications have specific endpoints that they're allowed to access depending on whether the application is a Client or an Admin. Client applications represent a Chrome Extension, a Mobile Safari Extension or a similar client software. Admin applications represent a system or server that you'll use to fetch all commissions for all client applications.

Both Client and Admin applications must create a device using Wildfire's API before doing any other operation. Creating a device is the first part of our authentication flow. You'll notice that inside Client Endpoints -> Device that there's a Create Device call. Similarly, the Admin Endpoints > Device also has a Create Device call. These are the same call, but the difference between the two is the app ID and secret you use to invoke the call. Every Wildfire partner has at least one Client app ID and secret and one Admin app ID and secret. Be sure that you're using the right credentials for the right use case. If you're developing a system to fetch all the commissions for your account (across all clients that have been created) then you'll want to be sure to use the Admin app ID and secret.

Once you're sure you've got the right credentials, you'll want to create a new Postman Environment. Environments are how Postman keeps credentials and other volatile/sensitive values separate from the collection endpoints, documentation, etc. Your new Environment will have just two keys in it: app_id and app_secret . Once those are set, be sure to save the Environment and then select it as your active Environment. Now you'll be able to create a device and call the rest of the endpoints. The pre-request script takes the app_id and app_secret and generates all the necessary headers each time a call is made.

Once you're done exploring the APIs with Postman, you can examine the pre-request script, which is mostly JavaScript, to get a sense for how to build these auth headers on your own (i.e. if you're working on a server-based solution).