Hi Marley Public API - Postman Collection

Introduction

Hi Marley's Public API Suite is available for copy and testing via our Postman Collection, linked below. The Postman Collection is intended to serve as a repository for all Hi Marley API endpoints, most with supporting API specs that can be found through our Zendesk pages on this site.

This article is not intended to serve as a full review of Postman capabilities but provides the basic information needed to find, copy, and run the Hi Marley Public API via Postman. If you have any questions about our API suite or Postman, please contact your Hi Marley representative.

Table of Contents

• Hi Marley Public API on Postman
• Using our Public API on Postman
• Formatting your API Key in Postman

Hi Marley Public API on Postman

The Hi Marley Public API can be found on the link below. Because this is our public collection, you will not need a username or password to access this page. Running API requests pulled from this page requires a Hi Marley API Key. If you do not have your API Key(s), you can retrieve this by contacting your Hi Marley representative.

https://apidocs.himarley.com/

Using our Public API on Postman

Our Postman Collection can be forked and downloaded for free by clicking the Run in Postman button in the upper righthand corner of the screen. By clicking this and selecting Postman Web to Fork, you can access a copy of our API via your browser. If you have the Postman application on your device, you can select Postman Desktop App to Import to download a copy to the application.

Our Postman Collection defaults to the UAT version of our API, so any API requests made here will use the UAT base URL by default. If you would like the Hi Marley Production base URL, please contact your Hi Marley representative for more information.

Formatting your API Key in Postman

Once you have your API Key, you can add this to Postman to run API requests. In Postman, under the Authorization tab, set Auth Type to API Key, In the fields that appear, enter "x-api-key" in the Key field and the actual API Key in the Value field.