Unit Map

Unit Map™ Developer Hub

Welcome to the Unit Map developer hub. You'll find comprehensive guides and documentation to help you start working with the platform as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Authentication

For requests which require Authentication, an API Key must be provided by either the api-key query parameter or API-Key header. We recommend the header as it keeps your API Key from being logged in Browser history and address bars.

# Via the query parameter
curl -i https://api.unitmap.com/v1/maps?api-key=YOUR_API_KEY

# Via the header
curl -i -H "API-Key: YOUR_API_KEY" https://api.unitmap.com/v1/maps

Only HTTPS is supported to ensure data privacy; HTTP is not supported.

If neither query parameter or header is provided, the following 401 HTTP response is returned:

HTTP/1.1 401 Unauthorized
Content-Type: application/json; charset=utf-8

{
	"message": "No API key found in headers or querystring"
}

If your API key cannot be validated, the following 403 HTTP response is returned:

HTTP/1.1 403 Forbidden
Content-Type: application/json; charset=utf-8

{
	"message": "Invalid authentication credentials"
}

Updated 3 years ago


What's Next

Understand how the API is versioned.

Versioning

Authentication


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.