Introduction

This section describes the localeUI API. The API is a RESTful API that makes it possible to access all functions of localeUI. The API is divided into different resources, each of which provides a specific functionality.

All API requests must be made via HTTPS and require valid authentication. The API endpoints accept input in JSON format and return JSON encoded responses by default.

The base URL for all API requests is https://localeui.com/api/v1/. All endpoints are relative to this base URL.

Authentication

The API requires authentication in order to access the resources. Authentication takes place via an API key.

More information

Errors

Various errors can occur when using the API. The API returns standardized error messages that contain the error code and a description of the error.

More information

Resources

The API is divided into different resources, each of which provides a specific functionality. Each resource has its own endpoints and methods that can be used to access or change the data.

More information