Skava Skava / Wiki

Elementos personalizados: API

Una interfaz API es un formulario cuyos valores completados Skava envía como JSON a una dirección que especifiques (tu backend). De esta manera puedes conectar Skava de forma segura con tus propios sistemas.

i

Administras interfaces API en la aplicación web en Elementos personalizados → alterna Interfaces API. La creación y edición se reservan para administradores de empresa; las interfaces liberadas luego pueden ser activadas por todos los miembros de la empresa.

Configurar una interfaz API

Una interfaz consiste en campos de entrada (forman el JSON), la dirección de destino y autenticación.

  1. Crear campos: Cada campo obtiene una clave JSON. A la derecha ves en vivo la vista previa de JSON, que se envía a tu backend exactamente de esta manera.
  2. Dirección (URL): la dirección https:// de tu backend. Solo se permiten direcciones HTTPS y accesibles públicamente (ver Seguridad más abajo).
  3. Método: POST (predeterminado), PUT, PATCH o GET. Con GET los valores se adjuntan como parámetros de consulta en lugar de enviarse en el cuerpo.
  4. Autenticación: Establece el nombre del encabezado (p. ej. Authorization) y el prefijo de valor (p. ej. Bearer ), luego guarda el token. Opcionalmente establece una fecha de vencimiento.
  5. Campos de respuesta (opcional): Define por ruta qué valores de la respuesta del backend se deben mostrar — p. ej. order.id o items[0].sku.
  6. Comprueba con Ping y Solicitud de prueba, luego Liberar.

Almacenar token de forma segura

El token se almacena encriptado y nunca se devuelve a los clientes — la aplicación solo muestra si se establece un token y cuándo vence. Al enviar, Skava lo adjunta del lado del servidor al encabezado configurado. Si estableces una fecha de vencimiento, Skava rechaza la llamada después del vencimiento y te pide que renueves el token.

Prueba: Ping y Solicitud de prueba

  • Ping — una comprobación ligera de alcanzabilidad. Solo comprueba si tu dirección responde, y no envía token o datos de formulario en el proceso. Muestra alcanzabilidad, estado y tiempo de respuesta. Ideal como primer paso.
  • Solicitud de prueba — la prueba real: envía datos de ejemplo incluyendo token a tu dirección y te muestra la respuesta completa así como los campos de respuesta extraídos.

Como administrador, puedes ejecutar ambos mientras aún estás en modo borrador para verificar la integración antes de la liberación.

Borrador y liberación

Cada interfaz comienza como un borrador y se puede editar libremente. Una vez que todo esté listo, lo liberas con Liberar.

!

Las interfaces liberadas son inmutables. Esto es intencional: para que después de la liberación nadie pueda intercambiar secretamente la dirección de destino o el token. Si quieres cambiar algo, crea una nueva versión.

Seguridad

i

Para evitar que la interfaz sea utilizada indebidamente, se aplican reglas estrictas: solo se permiten direcciones HTTPS, y la dirección debe apuntar a una dirección de destino pública — se rechazarán direcciones internas (p. ej. localhost, redes privadas o metadatos de la nube). Skava comprueba esto en cada llamada, se conecta exactamente a la dirección verificada, no sigue redirecciones y limita el tiempo de espera y el tamaño de respuesta.

Relacionado

¿Quieres construir una plantilla de documento rellenable? Ver Elementos personalizados: Documentos.

Preguntas frecuentes

¿Qué es una interfaz API en Skava?

Un formulario cuyos valores completados Skava envía como JSON a una dirección que especifiques (tu backend) — útil para conectar Skava con tus propios sistemas.

¿Quién tiene permitido crear y activar interfaces API?

La creación y edición se reservan para administradores de empresa. Una interfaz liberada luego puede ser activada por todos los miembros de la empresa.

¿Cuál es la diferencia entre "Ping" y "Solicitud de prueba"?

Ping solo comprueba si la dirección es alcanzable — sin token y sin datos. Solicitud de prueba envía datos de ejemplo incluyendo token y muestra la respuesta completa.

¿Es mi token de API seguro?

Sí. El token se almacena encriptado y nunca se entrega a clientes. La aplicación solo muestra si se establece un token y cuándo vence.

¿Qué direcciones se permiten como puntos finales?

Solo direcciones https:// accesibles públicamente. Los destinos internos como localhost, redes privadas o metadatos de nube se rechazarán — esto protege contra el uso indebido de la interfaz.

¿Por qué ya no puedo cambiar una interfaz liberada?

Las interfaces liberadas son intencionalmente inmutables — para que después de la liberación nadie pueda intercambiar la dirección de destino o el token. Para cambios, creas una nueva versión.