Exception handling

Errors

Error codes used by the API

All API errors are returned in a 2-tuple form:

{:error, reason}

The shape of reason depends on the type of failure.

Sample handling pattern

case ElixirLokaliseApi.Projects.find(project_id) do
  {:ok, data} ->
    IO.inspect(data)

  {:error, error_tuple} when is_tuple(error_tuple) ->
    {err_map, status} = error_tuple
    IO.inspect(err_map)
    IO.inspect(status)

  {:error, reason} ->
    IO.inspect(reason)
end

API Rate Limits

Access to all endpoints is limited to 6 requests per second from 14 September, 2021. This limit is applied per API token and per IP address. If you exceed the limit, a 429 HTTP status code will be returned and the corresponding exception will be raised that you should handle properly. To handle such errors, we recommend an exponential backoff mechanism with a limited number of retries.

Only one concurrent request per token is allowed.