Información
Mi contenido

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.

Estructura 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
  "action":     "...",     // Action to perform  
  "model":      "...",     // Model to perform the action to  
  "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 del producto
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
   
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, use kmd al reenviar la autenticación
222 Dos factores: Código OTP incorrecto, use kmd al reenviar la autenticación
223 Dos factores: Falta el código de correo, el correo se envía ahora, use kmd al reenviar la autenticación
224 Dos factores: código de correo incorrecto, el correo se envía ahora, use kmd al reenviar la autenticación
225 Dos factores: Falta el código SMS, el SMS se envía ahora, use kmd al reenviar la autenticación
226 Dos factores: Código SMS incorrecto, SMS se envía ahora, use kmd al reenviar la autenticación
   
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.

Volver arriba