Support forum
wyDay blog
wyDay Home

Web API Overview

The LimeLM web API consists of a set of callable methods, and some API endpoints.

To perform an action using the LimeLM web API, you need to select a calling convention, send a request to its endpoint specifying a method and some arguments, and will receive a formatted response.

Prior to January 1st, 2021, request can either be "GET" or "POST" and either HTTP or HTTPS. From January 1st, 2021 onward all requests must be "POST" over HTTPS; otherwise you will get error code "168".

All request formats, listed on the web API index page, take a list of named parameters.

The REQUIRED parameter method is used to specify the calling method.

The REQUIRED parameter api_key is used to specify your API Key.

The optional parameter format is used to specify a response format.

The arguments, responses and error codes for each method are listed on the method's spec page. Methods are lists on the web API index page.

Note: The LimeLM web API exposes identifiers for product keys, versions, products and other uniquely identifiable objects. These IDs should always be treated as opaque strings, rather than integers of any specific type. The format of the IDs can change over time, so relying on the current format may cause you problems in the future.