Getting Started

This page will help you get started with Loyale API.

The Loyale API is organised around the REST architecture, it accepts form-encoded request bodies and returns data in JSON. To indicate the status of the request HTTP response codes are used. The following are status codes that are returned by the Loyale Api:

Status Code

Status Code Name

Summary

200

OK

Everything worked as expected, usually includes a response object.

204

No Content

Everything worked as expected, and no response content was needed to be returned.

202

Accepted

Your request has been accepted for background processing.

401

Unauthorized

No valid access token provided.

403

Forbidden

The access token doesn't have permissions to perform the request.

404

Not Found

The requested resource doesn't exist.

429

Too many requests

Too many requests were sent to the API too quickly

500

Internal Server error

Something went wrong on Loyale's end. (These are rare.)