API Keys

Introduction:

The purpose of your API Key is to authenticate requests from your organization before being ingested by Hi Marley. Your organization will be given 2 API Keys upon going live. The first will be for your UAT (User Acceptance Testing) environment. The second will be for your Production environment. You can mint more keys using the POST Add New API Key to Org API, but Hi Marley will only allow for up to 5 API Keys per environment (10 total, 5 keys for UAT, and 5 keys for Production).

Where Can I Find my API Key?

• If you do not have access to your API key, please reach out to [e-mail]
• Our Integration Team will send the requested API Key to your technical team via encrypted messaging service.
• Please specify for which environment (UAT or Production) you are requesting your API Key and include any relevant information.

I'm Returning an Invalid API Key Error

Error may appear as the following:

{
    "errors": [
        {
            "category": "ClientError",
            "code": "INVALID_API_KEY",
            "detail": "Forbidden",
            "method": "GET",
            "path": "/subscribed",
            "requestId": "12345",
            "retryable": false
        }
    ]
}

• Ensure your request contains the following header:

x-api-key: <API Key>

• Occasionally, an improperly formatted request may return an Invalid API Key error.
  • Compare your request to our Postman API Documentation to ensure your request is formatted properly.
• Ensure your organization does not have more than 5 API Keys per environment. 
• If you are still running into issue, please contact [e-mail] and we will be happy to assist.