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 getting the postman collection you can download/access the postman collection via one of the following links, depending on your preference postman web client postman desktop app you can also download the desktop postman client if you don't yet have it if you've already got the postman collection or if you're just looking for the api documentation, you can find that here wildfire api documentation 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 creating a wildfire device 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 next steps 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) note that our servers require requests to have a user agent header you can put any value in this header if this header is missing or empty, the server will respond with an error 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 getting the postman collection you can download/access the postman collection via one of the following links, depending on your preference postman web client postman desktop app you can also download the desktop postman client if you don't yet have it if you've already got the postman collection or if you're just looking for the api documentation, you can find that here wildfire api documentation 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 creating a wildfire device 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 next steps 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) note that our servers require requests to have a user agent header you can put any value in this header if this header is missing or empty, the server will respond with an error