Fe de hechos de una API

En el ámbito del derecho, la fe de hechos es un documento emitido por un notario o autoridad competente que certifica que un evento o acción ha tenido lugar. En términos de tecnología, y específicamente en el desarrollo de software y servicios web, el concepto de fe de hechos puede aplicarse para describir el registro o verificación de las interacciones entre computadoras que sucede mediante una llamada API. En este contexto, se busca garantizar que una operación fue ejecutada y que los datos intercambiados entre el cliente y el servidor son los esperados. Este artículo explora el concepto de una “fe de hechos” en el marco de las llamadas API y hablaremos sobre todo lo que uno no entiende de derecho notarial, combinado con todo lo que uno no entiende de tecnología.

¿Qué es una llamada API?

Una API (Interfaz de Programación de Aplicaciones, por sus siglas en inglés) es un conjunto de reglas y protocolos que permiten que diferentes aplicaciones se comuniquen entre sí. Las llamadas API son solicitudes realizadas por un cliente a un servidor para obtener, modificar, eliminar o crear información. Te invitamos a leer este artículo, APIs para notarios, para entender mejor qué son estas APIs.

La Fe de Hechos en una API

En el contexto de una llamada API, la fe de hechos puede referirse a una confirmación documentada de que una solicitud se ha realizado de manera correcta a un servidor, junto con los resultados y respuestas obtenidos. Esta confirmación puede ser esencial para auditorías, validaciones de integridad de los datos, resolución de conflictos y para garantizar que la comunicación entre sistemas es transparente y verificable.

Ejemplos concretos de una fe de hechos de una API

Para entender a profundidad de qué nos puede servir esta fe de hechos, primero hay que entender que para poder dar por cierto que algo sucedió en el mundo tecnológico, simplemente decir que es verdad porque aparece en una interfaz gráfica, no es suficiente. 

Es decir, que aparezca un mensaje en una conversación de Whatsapp no te garantiza que sí se envió ese mensaje.  Sin embargo, analizar el proceso mediante el cuál se solicitan los mensajes de Whatsapp directamente desde el servidor donde son procesados, y certificar este proceso, brinda mucha más certeza.  Es justo aquí que nos sirve certificar esta llamada API y muchas de estas están muy bien documentadas, como la de Whatsapp.   Algunos ejemplos prácticas:

• Transacciones bancarias: Al realizar pagos o transferencias, puede auditarse cada paso de la transacción. Una fe de hechos puede certificar que la solicitud fue enviada, recibida y procesada correctamente, protegiendo tanto al cliente como al banco.

• E-commerce: En plataformas de comercio electrónico, se utilizan APIs para gestionar inventarios, realizar pedidos y procesar pagos. La fe de hechos puede documentar que un pedido fue registrado correctamente o que un pago se procesó en un momento determinado.

• Plataformas de redes sociales: Cuando se publican contenidos a través de APIs en redes sociales (como usar API de Twitter para publicaciones automáticas), una fe de hechos asegura que las publicaciones fueron realizadas en el momento adecuado y sin errores.

• Firmas digitales y contratos inteligentes: En sistemas que gestionan contratos electrónicos o blockchain, una fe de hechos puede asegurar que los documentos o contratos firmados a través de API son válidos, auditando tanto la solicitud como la respuesta.

Elementos de una Fe de Hechos en una Llamada API

Son varias las cosas que deberían de guardarse al momento de realizar una fe de hechos de una API.  Estos son datos técnicos que describen el llamado y que pudieran reutilizarse para hacer el mismo llamado de nuevo (en ciertos cosas y con algunas modificaciones como tokens de seguridad).

1. Registro de la Solicitud:

   • Método HTTP: Se debe registrar qué tipo de solicitud técnica se ha realizado (GET, POST, PUT, DELETE, etc.).
   • Endpoint: Especificar a qué endpoint o URL se ha hecho la llamada.
   • Cuerpo de la Solicitud: Si aplica, documentar el cuerpo de la solicitud, que contiene los datos enviados al servidor.
   • Cabeceras: Incluir información sobre las cabeceras utilizadas, como autorizaciones o formatos de contenido (JSON, XML, etc.).

2. Registro de la Respuesta:

   • Código de Estado HTTP: La respuesta del servidor incluye un código de estado HTTP (200 para éxito, 404 para no encontrado, etc.). Este código forma parte esencial de la fe de hechos.
   • Cuerpo de la Respuesta: Documentar los datos o mensajes que el servidor devuelve, ya sea en JSON, XML o algún otro formato.
   • Cabeceras de la Respuesta: Registrar información adicional como el tipo de contenido o el tiempo que tardó la respuesta.

3. Timestamps:

   • La fecha y hora en que la solicitud se realizó y se recibió la respuesta es crucial para la trazabilidad y auditoría.

4. Autenticación y Autorización:

   • Si la llamada API requería algún tipo de autenticación (tokens, claves API, OAuth, etc.), es necesario dejar constancia de que el cliente estaba autorizado para realizar la solicitud.

Ejemplo de Fe de Hechos en una Llamada API

Imaginemos un sistema donde un cliente realiza una solicitud POST a una API para crear un nuevo usuario. La fe de hechos sería algo como lo siguiente:

• Solicitud:

  • Método: POST
  • Endpoint: /api/users
  • Url: https://nuvigant.com
  • Cuerpo de la solicitud: { "name": "Juan Pérez", "email": "[email protected]" }
  • Cabeceras: Authorization: Bearer <token>

• Respuesta:

  • Código de estado: 201 Created
  • Cuerpo de la respuesta: { "id": 12345, "name": "Juan Pérez", "email": "[email protected]" }
  • Cabeceras: Content-Type: application/json

• Timestamps:

  • Solicitud: 2024-09-26T10:15:30Z
  • Respuesta: 2024-09-26T10:15:32Z

Este registro serviría como una fe de hechos de la llamada API, demostrando que el usuario Juan Pérez fue creado correctamente en el sistema, a qué hora sucedió y bajo qué circunstancias.

Conclusión

La fe de hechos aplicada a las llamadas API es esencial para garantizar la integridad, seguridad y transparencia en los sistemas modernos. No solo permite auditar y validar que una solicitud se haya procesado correctamente, sino que también proporciona una base sólida para la resolución de conflictos y la mejora de la seguridad. En un mundo cada vez más dependiente de la interconexión de sistemas mediante API, contar con este tipo de registros es más importante que nunca.