API general
La API general está diseñada para poder obtener, enumerar, 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 proporciona varias acciones (obtener/listar/actualizar/...). Puedes utilizar la llamada para info para recibir la especificación OpenAPI de todos los modelos y acciones:
https://[API-Endpoint]/infoTenga 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 posibles para su cuenta, autentíquese primero.
Estructura de URL
Las llamadas a modelos siguen la estructura:
https://[API-Endpoint]/model/[MODELNAME]/[ACTIONNAME]Ejemplo:
https://[API-Endpoint]/model/CMP/listAdemás de las llamadas de modelo, existen llamadas a la autenticación y la especificación OpenAPI:
https://[API-Endpoint]/auth/[AUTH-ACTION]
https://[API-Endpoint]/infoEstructura general de mensajes
La comunicación se realiza enviando datos JSON de un lado a otro. Para iniciar una acción, envíe 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 según la acción a realizar. Por lo tanto, consulte la sección Acciones aquí.
Dependiendo de la implementación del proyecto un key puede ser necesario para determinadas acciones (por ejemplo, crear un nuevo usuario). Póngase en contacto con su administrador de cuenta para recibir su clave.
Importante: Mantenga su clave privada y no la transmita a través del navegador, ¡sino siempre a través de una conexión de servidor a servidor!
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 del statuscode propiedad de la respuesta.
| Código | Descripción |
| 100 - 199 | Códigos de error generales |
| 101 | No se encontraron datos de entrada |
| 102 | view / accessType falta o es incorrecto |
| 103 | No se han enviado ID / ID no válidos. Envíe al menos una identificación |
| 104 | Filtro incorrecto: el campo X no existe en Y |
| 105 | falta acción o es incorrecta |
| 106 | El parámetro X es obligatorio / falta |
| 107 | Acción de barra de herramientas vacía o desconocida |
| 108 | Acción no permitida |
| 109 | Accion: Fallida |
| 110 | La acción permite no más de una o ninguna identificación. |
| 111 | No se encontraron datos para ID x. |
| 112 | Crear error, ver mensaje de error. Los mensajes específicos del campo ver response.data |
| 113 | Error de actualización, consulte el mensaje de error. Los mensajes específicos del campo ver response.data |
| 114 | No hay datos para crear / actualizar un artículo |
| 115 | Los ID deben ser una matriz |
| 116 | No puedo firmar la contraseña |
| 117 | Se superó la cantidad máxima de artículo |
| 200 - 299 | Errores de inicio de sesión / acceso |
| 201 | Servidor de anuncios desactivado |
| 202 | Usuario no encontrado |
| 203 | IP en la lista negra |
| 204 | Contraseña incorrecta |
| 205 | Credenciales faltantes |
| 206 | Error de inicio de sesión desconocido |
| 207 | IP no incluida en la lista blanca |
| 208 | Cambio de contraseña necesario (contraseña demasiado antigua) |
| 209 | Acceso no permitido |
| 210 | Renovación de contraseña no exitosa |
|
211 |
Token incorrecto |
| 212 | Token caducado |
| 213 | Cuenta aún no activa |
| 214 | Tipo de acceso desconocido |
| 215 | Se necesita cambio de contraseña |
| 216 | Desactivado |
| 217 | Error desconocido |
| 218 | Falta la clave de autenticación o está vacía |
| 219 | Falta la autenticación de dos factores (enviar parámetro 2fa) |
| 220 | Autenticación de dos factores incorrecta |
| 221 | Dos factores: falta el código OTP |
| 222 | Dos factores: Código OTP incorrecto |
| 223 | Dos factores: falta el código de correo |
| 224 | Dos factores: código de correo incorrecto |
| 225 | Dos factores: falta el código SMS |
| 226 | Dos factores: código SMS incorrecto |
| 227 | Dos factores: el correo se envía ahora |
| 228 | Dos factores: el SMS se envía ahora |
| 229 | Se envió el correo electrónico de actualización de contraseña |
| 230 | Contraseña actualiza |
| 300 - 399 | Códigos de error interno |
| 301 | No se pudo resolver la dependencia de X en Y |
| 302 | La dependencia de X resultó en una lista vacía |
| 303 | No hay columna para actualizar |
| 304 | Error de dependencia en el uso del campo |
| 305 | Error de dependencia en campo vacío |
| 306 | La consulta de lista dio como resultado una lista de campos vacía |
| 307 | Devolución de llamada de autenticación no encontrada |
| 308 | Archivo de inclusión de API no encontrado: ... |
| 399 | Error interno general |
| 900 - 999 | Códigos de error personalizados, consulte el mensaje |
Tipos de acceso
Dependiendo de la estructura de la API, existen diferentes tipos de acceso (campo JSON "accessType"). Póngase en contacto con su administrador de cuentas para recibir la identificación del tipo de acceso que puede usar.
Modelos
Dependiendo del proyecto y sus derechos de acceso, es posible que vea diferentes modelos (estructuras de datos para recibir / insertar desde / en la base de datos). Por favor llame a la acción rights para recibir una lista de modelos y acciones.
