Saltar al contenido principal

Nodo admin-api

La nodo admin-api proporciona acceso directo a la API interna de OneEntry. Con ella, se pueden leer y modificar pedidos, páginas, usuarios, colecciones y sesiones de pago directamente desde el flujo de integración, sin necesidad de escribir solicitudes HTTP manualmente.

Configuraciones de la nodo admin-api​

IMG2

1. Nombre​

Campo para especificar el nombre de la nodo.
El nombre se muestra en el área de trabajo y ayuda a identificar fácilmente la nodo.
Si se deja vacío, la nodo se llamará admin-api.

Ejemplo:

  • Nombre de la nodo: Crear Sesión de Pago

2. Tipo​

Selección del método de API que se llamará al pasar un mensaje a través de la nodo. Métodos disponibles:

  • "Actualizar objeto de página" — Actualización del objeto de página
  • "Buscar todos los objetos en páginas de productos con paginación para la categoría seleccionada" — Búsqueda de productos con paginación
  • "Cambio del estado de la página del producto" — Cambio del estado de la página del producto
  • "Actualización de la página del producto" — Actualización de la página del producto
  • "Actualización del objeto de usuario - administrador" — Actualización del objeto de usuario (por un administrador)
  • "Actualizar un objeto de usuario" — Actualización de un objeto de usuario
  • "Actualización del valor de un atributo de entidad" — Actualización del valor del atributo de la entidad
  • "Recibir todos los pedidos pertenecientes al objeto de almacenamiento de pedidos" — Recepción de todos los pedidos del almacenamiento
  • "Actualizar el estado de un pedido perteneciente al objeto de almacenamiento de pedidos" — Actualización del estado del pedido
  • "Actualización de la sesión de pago" — Actualización de la sesión de pago
  • "Recibir un objeto de sesión de pago por su identificador" — Recepción de la sesión de pago por ID
  • "Crear una sesión de pago" — Creación de una sesión de pago
  • "Recibir todos los registros pertenecientes a la colección" — Recepción de registros de la colección
  • "Crear un registro en la colección" — Creación de un registro en la colección
  • "Cambiar un registro en la colección" — Cambio de un registro en la colección
  • "Eliminar un objeto del registro de la colección" — Eliminación de un objeto del registro de la colección

3. Parámetros de consulta​

Parámetros de la solicitud URL. El campo utiliza la sintaxis Mustache — los valores de msg se pueden insertar a través de {{variable}}.

Ejemplo (para el método "Recibir todos los registros pertenecientes a la colección"):

{
  "entityType": "orders",
  "entityId": "{{orderId}}",
  "langCode": "es_ES",
  "offset": 0,
  "limit": 1,
  "marker": "delivery"
}

4. Cuerpo de la solicitud​

Cuerpo de la solicitud en formato JSON. Soporta Mustache para la inserción de datos de msg.

Ejemplo (para el método "Crear una sesión de pago"):

{
  "orderId": {{orderId}},
  "type": "session"
}

5. Esquema de entrada​

El bloque Esquema de entrada se muestra en la configuración de la nodo y muestra la estructura de datos que provienen de la nodo anterior en el flujo. El esquema se presenta en forma de pares "clave - tipo", teniendo en cuenta la anidación de objetos.

Si los campos del esquema están descritos en Swagger, junto a ellos se muestran descripciones textuales. Estas mismas descripciones son capturadas por el editor de código (Monaco) como sugerencias al escribir plantillas Mustache.

Ejemplo de visualización del Esquema de entrada:

payload
  └── order
        ├── id           (integer)  — Identificador del pedido
        ├── status       (string)   — Estado actual
        └── totalPrice   (number)   — Monto total

6. Botón Ejecutar​

El botón Ejecutar permite realizar una solicitud API directamente desde el formulario de edición de la nodo, sin necesidad de ejecutar todo el flujo.

Cómo funciona:

  • El servidor ejecuta todo el flujo desde el principio hasta esta nodo, pasando los datos en cadena de acuerdo con el último estado publicado del flujo.
  • Si alguna nodo function en el camino no pasa datos más allá, pero tiene el campo Ejemplo de salida (JSON) completado, esos datos se utilizan como simulados.
  • En caso de respuesta exitosa, la respuesta de la API se pasa a la siguiente nodo como esquema.
  • Si la solicitud devuelve un error, el esquema no se pasa a la siguiente nodo.
info

Antes de usar el botón Ejecutar, asegúrate de que el flujo esté publicado. El servidor ejecuta la cadena según el estado de la última publicación.

Impacto en el esquema:

La nodo admin-api tiene inicialmente un esquema de respuesta de Swagger. Al presionar Ejecutar, el esquema se sobrescribe con la respuesta real de la API. En este proceso, los campos que coinciden con la descripción de Swagger mantienen sus descripciones textuales.

7. Llamada automática a solicitudes de solo lectura​

Todas las nodos admin-api que realizan solicitudes solo de lectura (GET) se llaman automáticamente:

  • al abrir la página de Integraciones,
  • al actualizar el flujo a través del botón Publicar.

Esto permite siempre tener un esquema de datos actualizado en la siguiente nodo sin necesidad de iniciar manualmente.

Ejemplos de uso​

Ejemplo 1: Creación de una sesión de pago​

Configuraciones de la nodo:

  • Tipo: Crear una sesión de pago
  • Cuerpo de la solicitud: 
    {
      "orderId": {{orderEvent.order.id}},
      "type": "session"
    }

Resultado:
La nodo crea una sesión de pago, utilizando orderId del mensaje entrante, y pasa los datos de la nueva sesión a la siguiente nodo.

Ejemplo 2: Actualización del estado del pedido​

Configuraciones de la nodo:

  • Tipo: Actualizar el estado de un pedido perteneciente al objeto de almacenamiento de pedidos
  • Parámetros de consulta: 
    {
      "id": {{orderId}}
    }
  • Cuerpo de la solicitud: 
    {
      "status": "{{newStatus}}"
    }

Resultado:
La nodo actualiza el estado del pedido, utilizando los datos del mensaje entrante.

Ejemplo 3: Recepción de registros de la colección​

Configuraciones de la nodo:

  • Tipo: Recibir todos los registros pertenecientes a la colección
  • Parámetros de consulta: 
    {
      "entityType": "delivery",
      "entityId": "{{payload.id}}",
      "langCode": "es_ES",
      "offset": 0,
      "limit": 10
    }

Resultado:
La nodo devuelve una lista de registros de la colección. Dado que se trata de una solicitud de solo lectura, al abrir la página, el esquema de respuesta se carga automáticamente.