Skip to main content

Introduction

The Harlyy API is organized around REST.

Our API has predictable resource-oriented URLs, accepts raw JSON request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The Harlyy API doesn't support bulk updates. You can work on one object per request.

There are two main APIs in Harlyy, the resource API and the OAuth API. The resource API is used to interact with the Harlyy platform, while the OAuth API is used to authenticate and authorize users. When using this documentation, for any endpoints, assume that is uses the resource base URL unless specified.

Resource Base URL
https://api.harlyy.com
OAuth Base URL
https://auth.harlyy.com
tip

We recommend reading through the first section of this documentation to get familiar with concepts specific to the Harlyy API.

SDKs

Currently there exists no public SDKs to use our API. This is something we are looking at implementing in the future.