Search

Getting Started

Authentication

You will need a user name, password and customer code. If you are developing an API application to an ERPLY customer, please ask the customer to provide their customer code, and to create a user account for you. “Customer code” is a number consisting of up to 6 digits, eg.: 7704 or 100123.

First, perform an API “verifyUser” call to authenticate and receive a session key. This session key must be included in all subsequent API calls, as a simple POST parameter. Our sample PHP wrapper class does this automatically for you — authenticates when needed and adds session key to your API calls.

When the session expires (it is typically valid for 1 hour), your API calls start returning a 1054 or 1055 error. If you are developing an API wrapper class from scratch, we recommend you to make it automatically re-authenticate and re-issue an API call upon that kind of error.

If you do not have an Erply account yet, create it here.

Request and response format

Every API call is a HTTP POST request in traditional parameter1=value1&parameter2=value2 format. Server responds by sending an XML or JSON document containing status information and data records.

  • Request – HTTP POST
  • Response – JSON / XML document (you get to choose which). JSON is the default option.

Language specific API wrapper

If your language is not listed, check out the cURL example. It is really easy to write your own wrapper.

Available API requests

Almost all data that you can get through Erply user interface is also available via the API. Check out the menu on the left. If you have trouble finding anything, feel free to contact our support.

Security, request limits and error handling

Once you have mastered the basics of our API, be sure to read the advanced topics here.