La API general está diseñada para poder obtener, listar, actualizar, crear y eliminar entradas de datos en el sistema. Se puede utilizar para automatizar procesos como la gestión de proveedores o la creación de diseños.

Modelos y acciones

Cada tipo de datos (por ejemplo, un cmp, un diseño, un proveedor, etc.) se denomina modelo; cada modelo ofrece varias acciones (get/list/update/…). Puedes utilizar la llamada a info para recibir la especificación OpenAPI de todos los modelos y acciones:

https://[API-Endpoint]/info

Ten en cuenta que las llamadas no autenticadas al modelo de información darán lugar a una especificación OpenAPI para acciones no autenticadas. Para obtener todos los modelos y acciones disponibles para tu cuenta, autentícate primero.

Estructura de la URL

Las llamadas a la acción siguen la estructura:

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

Ejemplo:

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

Además de las llamadas a modelos, hay llamadas a la autenticación y a la especificación OpenAPI:

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

Estructura general del mensaje

La comunicación se realiza mediante el intercambio de datos JSON. Para iniciar una acción, envía una solicitud POST con los siguientes datos JSON en el cuerpo HTTP:

{
  "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
}

El contenido de los datos JSON puede variar en función de la acción que se vaya a realizar. Por lo tanto, consulta la sección Acciones aquí.

Dependiendo de la implementación del proyecto, key puede ser necesaria para determinadas acciones (por ejemplo, crear un nuevo usuario). Ponte en contacto con tu gestor de cuentas para recibir tu clave.

La API responderá con un cuerpo JSON con el siguiente formato:

{
  "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  
}

Códigos de error

La API utilizará los siguientes códigos de error para señalar problemas. El código de error se envía a través de la statuscode propiedad de la respuesta.

Tipos de acceso

Dependiendo de la estructura de la API, existen diferentes tipos de acceso (campo JSON «accessType»). Ponte en contacto con tu gestor de cuentas para recibir el ID del tipo de acceso que puedes utilizar.

Modelos

Dependiendo del proyecto y de tus derechos de acceso, es posible que veas diferentes modelos (estructuras de datos que se deben recibir o insertar desde o hacia la base de datos). Haz clic en el botón de acción rights para recibir una lista de modelos y acciones.