API - Introduction

Hanger51 provides a HTTP API for managing assets (files and images). In production environments the API should always be accessed over a HTTPS connection (to prevent API keys being discovered).

---

Authentication

All API endpoints must be authenticated, to authenticate a call simply specify a valid API key against the parameter api_key.

---

Response format

All data is sent/returned in JSON format. Date/times use the format YYYY-MM-DD HH:MM:SS and the time zone is set in the event configuration.

Responses always have the following structure:

{
    "status": "{success|fail}",
    "payload": {...optional payload containing the response...}
}