The general API is designed to be able to get, list, update, create and delete data entries in the system. It can be used to automate processes like vendor management or design creation.

Models & Actions

Each data type (e.g. a cmp, a design, vendor and so on) is called a model, each model provides several actions (get/list/update/…). You can use the call to info in order to receive the OpenAPI spec of all models and actions:

https://[API-Endpoint]/info

Please note that unauthenticated calls to the info model will result in an OpenAPI spec for unauthenticated actions. In order to get all Models & Actions that are possible for your account, please authenticate first.

URL structure

Calls to models follow the structure:

https://[API-Endpoint]/model/[MODELNAME]/[ACTIONNAME]

Example:

https://[API-Endpoint]/model/CMP/list

In addition to model calls, there are calls to authentication and the OpenAPI spec:

https://[API-Endpoint]/auth/[AUTH-ACTION]
https://[API-Endpoint]/info

General message structure

Communication is done by sending JSON data back and forth. In order to start an action, please send a POST request with the following JSON data in the HTTP body:

{
  "accessType": 1,         // Access type (may be required for authentication calls)
  "lang":       1|2|3|..., // Language (optional)  
  "kmd":        "...",     // Authentication token (optional/required depending on context)  
  "key":        "..."      // Your API-Key (optional/required depending on context)
  // other fields might be required depending on context
}

The content of the JSON data may vary depending on the action to be performed. Therefore please see the Actions section here.

Depending on the project implementation a key might be required for certain actions (e.g. creating a new user). Please get in touch with your account manager in order to receive your key.

The API will respond with a JSON body that is formated as follows:

{
  "status":     "...",  // Status: Success|Error 
  "statuscode": 0..999, // Status code
  "msg":        "...",  // Human readable status message
  "model":      "...",  // Context dependend. May return model type to be displayed or null
  "action":     "...",  // Action performed
  "data":        ...    // Type and content is depended on context  
}

Error codes

The API will use the following error codes in order to signal problems. The error code is send via the statuscode property of the response.

Access Types

Depending on the API structure different access types exist (JSON field “accessType”). Please get in touch with your accout manager in order to recieve the ID for the access type you can use.

Models

Depending on the project and your access rights, you may see different models (data structures to be received/inserted from/into the database). Please call action rights in order to receive a list of models and actions.