The calls to Erply API are HTTP POST requests.
Input parameters must be sent as POST parameters. Both form-data
and x-www-form-urlencoded
encoding options are supported.
API responds with a JSON document.
We also advise to add input parameter sendContentType=1
to every API call. This ensures that server will respond with an appropriate Content-Type header: application/json; charset=UTF-8
. For backward compatibility reasons, API does not return that header by default.
Compatibility and legacy features
Erply API calls also work if the parameters are sent in the query string: https://123.erply.com/api/?request=… However, this is kept for compatibility only; please do not use that option. Very long URLs are not supported by all systems, and sending authentication information in the URL is not recommended.
Optionally it is possible to retrieve data as XML instead of JSON: use input parameter responseType=XML
.