es
Recursos

Documentación API

El sitio del cliente, el back office y todos los módulos de la plataforma funcionan con archivos de base de datos a través de la API, y no directamente. La API controla el acceso, la integridad y la corrección de los datos entrantes.

Descripción general

¿Cómo funciona la API?

API - el nodo clave de la plataforma

Esta documentación describe todos los métodos API para las siguientes acciones:

  • obtener listas de objetos (método de lista)
  • filtrado de lista (método de lista con datos de filtro)
  • obtener información detallada sobre un objeto (método show)
  • obtener datos para el formulario de agregar objeto (método de agregar)
  • guardar datos como un nuevo objeto (método de almacenamiento)
  • obtener datos para el formulario de actualización de objetos (método de edición)
  • guardar los datos del objeto actualizado (método de actualización)

Comprobación por dirección IP

La API solo acepta solicitudes de una lista limitada de direcciones IP (por ejemplo, del sitio de la cuenta de un cliente o del sitio de la oficina administrativa).

Cualquier solicitud a la API desde una dirección IP que no esté en la lista permitida será rechazada.

Esto se hace para evitar ataques DDoS en la API, intentos de falsificar solicitudes y experimentos de piratas informáticos.

Los usuarios siempre acceden al sitio público de la plataforma (oficina del cliente o back office), y este mismo sitio solicita los datos necesarios a la API de la plataforma. Dado que la dirección IP del sitio es fija, estará en la lista de permitidos.

URL y método

Todas las solicitudes de API se realizan utilizando los siguientes métodos HTTP:

  • GET para listar, mostrar, agregar y editar
  • POST para tienda
  • PUT para actualizar
  • DELETE para eliminar

Cada sección de la API contiene una URL a la que se realiza una solicitud para obtener los datos relevantes.

El método de solicitud HTTP se especifica delante de cada URL.

Enviar una solicitud

Cada solicitud de API siempre debe contener 4 variables:

  1. data (cadena json con matriz de datos para API)
  2. user (cadena json con una matriz de datos sobre el usuario actual)
  3. time (hora actual en la zona horaria UTC)
  4. hash (firma digital en forma de hash para verificar que la solicitud a la API es definitivamente de una fuente autorizada)

Obtener respuesta de la API

Si la solicitud es exitosa, la API siempre devuelve dos variables:

  1. status = true (estado de éxito)
  2. data (cadena json con matriz de datos de API)

Si la solicitud falla, la API muestra las variables:

  1. status = false (estado de error)
  2. error (cadena de texto que describe el error)

Firma digital

Cada solicitud de API debe contener una variable hash que es la firma digital de la solicitud.

hash = md5($json . $time . $salt)

  • md5, sha256, bcrypt — algoritmos de cifrado disponibles
  • $json — cadena json con datos de solicitud
  • $time — hora en el formato "DD.MM.YYYY HH:MM:SS"
  • $salt — valor único fijo ("sal") para la plataforma API

Recursos

La documentación contiene ejemplos de solicitudes API reales