👨‍💻 Introducción a la API REST de Ugosign

🎯 Objetivo

Comprender los fundamentos de la API REST de Ugosign y realizar tu primera llamada autenticada para integrar la firma electrónica en tus aplicaciones web o móviles.

📝 Requisitos previos

• Una cuenta de Ugosign activa con permisos suficientes.
• Una clave de API (ver "🔑 Generar una clave de API en Ugosign").
• Conocimientos básicos de HTTP/REST y gestión de Authorization: Bearer <token>.
• Acceso de red HTTPS.

📍 Pasos

1. Crear y proteger tu clave de API
   Accede a tu panel de Ugosign y genera una clave. Almacénala de forma segura (gestor de secretos, variables de entorno, nunca en texto plano en el código).
2. Elegir el entorno y la URL base
   Usa las URL proporcionadas en la documentación y toma nota de la versión de la API.
3. Configurar la autenticación
   Añade la siguiente cabecera HTTP a cada solicitud: Authorization: Bearer <tu_clave_api>. Asegúrate de enviar y recibir application/json.

   GET /... HTTP/1.1
   Host: <base-url>
   Authorization: Bearer <tu_clave_api>
   Accept: application/json

4. Realizar una primera llamada de verificación
   Haz una llamada sencilla (p. ej. GET /api/v1/organization) para validar la autenticación y la conectividad.
5. Explorar la documentación interactiva
   Explora los endpoints disponibles, los esquemas de petición/respuesta y los códigos de error.

   Documentación de la API de Ugosign

✅ Resultado esperado

• Una clave de API activa y almacenada de forma segura.
• Una primera llamada HTTPS autenticada con respuesta 200 OK.
• Una visión clara de los endpoints relevantes para tu caso de uso.

💡 Para tener en cuenta

• Cumplimiento y seguridad: la API sigue las mejores prácticas de cifrado y protección de datos.
• Manejo de errores: consulta los códigos HTTP estándar y los mensajes de error estructurados.
• Buenas prácticas: rotación periódica de claves, principio de menor privilegio, registros seguros.

🔗 Recursos asociados

• Documentación de la API de Ugosign
• 🔑 Generar una clave de API en Ugosign