Quickstart
This guide will get you all set up and ready to use the Wunderite API. We'll cover how to get authenticated, and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful REST API.
Getting your API key
Before you can make requests to the Wunderite API, you will need to grab your API key from your Account Settings. You can find it under Account » Settings » Integrations. For more detailed instructions, see our knowledgebase article.
While each agent can setup their own API key, we recommend creating an "API User" specifically for API interaction. This will ensure any CRUD actions are attributed to the API user in your Wunderite activity logs.
Setting up your API client
To make requests to the Wunderite API, you can use any HTTP client library that supports sending GET, POST, PATCH, and DELETE requests with headers. There are two headers that are required with every request:
Authorization: Bearer {token}
: This header is used to authenticate your requests. Replace{token}
with your API key.Accept: application/json
: This header tells the API that you expect JSON responses.
Making your first API request
Use your API key with the example below to see how to send a GET request to the risk data endpoint to get a list of all buildings in a risk profile.
When encountering code examples in this guide, you can replace instances of {token}
with your API key and instances of {risk}
with a risk profile UUID. When viewing a risk profile in Wunderite, you can find the UUID by copying the string of 32 random characters (separated by dashes) that come after https://app.wunderite.com/risk-profiles/
in your browser's URL bar.
curl -G https://app.wunderite.com/api/v1/risks/{risk}/data/buildings \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json"
What's next?
Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Wunderite API: