Configuration API for Front-end Applications (CAFA)

This is a REST API for storing layered custom configuration settings — primarily for frontend applications.

CAFA offers calls for reading and writing configuration settings. The configuration is layered — it is possible to set a default value for the whole company and override/customize it at store level, register level or per-user.

  1. To find the endpoint specific for your account, use the "getServiceEndpoints" call.
  2. Each endpoint also provides Swagger documentation. For an example, see the documentation provided by the sandbox endpoint:

  3. Use an Erply client code and API session key to make requests. (Send these as headers "clientCode" and "sessionKey".)