Swagger UI

CAFA API
 4.19.2 

./swagger/doc.json

Configuration API with a tree-like hierarchy.

The API enables storing and retrieving JSON, JSON array or string configurations persistently.

Authentication

There are 4 methods:

  1. sessionKey + clientCode HTTP headers,
  2. apisession_<yourClientCode> cookie + clientCode HTTP header,
  3. JWT(identity token) HTTP header ,
  4. hmac-auth + clientCode HTTP headers + timestamps in every request for the master access.

Configurations hierarchy
Configuration declared on a level will propagate down to all the sub-levels underneath.

Levels of configurations

There are 4 levels of configurations:

  1. Company (highest),
  2. Warehouse,
  3. Pos,
  4. User (deepest).

Relationships

  1. Companies and warehouses have one-to-many relationship.
  2. Warehouses and POSes have many-to-many relationship.
  3. POSes and users have one-to-many relationship.

Request parameter descriptions
Please read descriptions for parameters, request bodies in the requests and request models.

v1

Import & Export

Sync

v3