Memsource Legacy API

Memsource Legacy API—API Reference

Important:

Memsource Legacy API will be deprecated in 2020. It is disabled for all new organization accounts created after May 7th 2019.
Please use Memsource REST API instead.

Synchronous APIs

Here is a list of all our Synchronous APIs:

Asynchronous APIs

Asynchronous APIs should always be preferred to their synchronous counterparts. If you call synchronous APIs, there is a chance of receiving timeout expired responses when processing large batches of files or even a single huge file. Synchronous APIs should only be used for small files and small-scale integration with Memsource.

Polling

After you call an asynchronous API, you will receive an instant response including the identifier request. You will use this identifier to check the status of the request by calling getAsyncRequest and checking the asyncResponse field. This polling approach can lead to a number of getAsyncRequest calls before you actually receive asyncResponse as not null.

Callbacks

As a response to the drawbacks of the polling approach to asynchronous requests, we have introduced support for callbacks in all asynchronous APIs. When calling an asynchronous request, you specify a URL (in the callbackUrl parameter) that will be requested from our side just after the work initiated by the asynchronous request is finished.

Callbacks are requested via HTTP POST calls, and the data is passed on in the body encoded as JSON. The JSON object always contains:

  • information about the asynchronous request (the same as when calling getAsyncRequest)
  • detailed information about the result of the action (for example, a full analysis or job details)
{
  "asyncRequest": {
   ...
  }
  "analyse": {
   ...
  }
}

If the callback URL is not accessible, the request will be repeated from our side after 2 minutes, then 4 minutes, 8 minutes, 16 minutes, and then after 30 minutes up to a total number of 10 retries.

Your callback URL must respond with the 200 OK HTTP status code to be considered successful on our side.

List of Asynchronous APIs

Errors