La API de firma electrónica Certyneo en Postman
Importe la colección pública Certyneo en Postman y pruebe cada endpoint de la API REST v1 — creación de sobres, envío, seguimiento de estado, webhooks — con ejemplos de solicitudes ya rellenados.
Colección gratuita y pública. Se requiere una clave API Certyneo para ejecutar las solicitudes.
Por qué usar la colección Postman Certyneo
La colección está diseñada para desarrolladores que desean explorar la API Certyneo sin leer toda la documentación antes de lanzar su primera solicitud.
Solicitudes listas para usar
Cada endpoint de la API REST v1 está documentado con un ejemplo de solicitud y respuesta, listo para ejecutar después de haber proporcionado su clave API.
Entornos de prueba
Una variable de entorno Postman contiene su clave API y la URL base, para cambiar fácilmente entre sus cuentas o entornos.
Documentación generada automáticamente
La documentación Postman de la colección permanece sincronizada con la especificación OpenAPI de la API Certyneo — sin desfase entre lo que prueba y lo que está en producción.
Probar sin escribir código
Cree un sobre, envíelo y siga su estado directamente desde la interfaz Postman, incluso antes de integrar la API en su aplicación.
Lo que cubre la colección
Una descripción general de los grupos de endpoints disponibles en la colección pública.
| Grupo | Lo que contiene |
|---|---|
| Sobres | Crear, enviar, listar, consultar y cancelar un sobre de firma. |
| Documentos | Cargar un documento o importarlo desde una URL (sourceUrl), consultar su estado. |
| Firmantes | Agregar destinatarios, definir su orden de firma y su nivel (SES/AES). |
| Webhooks | Crear y gestionar suscripciones a eventos de firma. |
| Envío en masa | Enviar múltiples sobres en una sola solicitud para campañas de firma en volumen. |
La colección es pública en lectura: puede consultarla sin cuenta, pero la ejecución de solicitudes requiere una clave API válida de Certyneo.
Empezar con la colección en 4 pasos
Menos de 5 minutos para lanzar su primera solicitud.
- 1
Importar la colección pública
Desde Postman, abra la colección pública de Certyneo y haga clic en « Fork » o « Import » para copiarla en su propio espacio.
- 2
Generar una clave API de Certyneo
En su panel de Certyneo, abra Parámetros → Claves API y cree una clave dedicada a Postman.
- 3
Rellenar la variable de entorno
Pegue su clave API en la variable de entorno de la colección Postman, así como la URL base de la API.
- 4
Enviar una primera solicitud
Lance la solicitud « Crear un sobre » y siga el resultado directamente en Postman.
Seguridad y mejores prácticas
Las solicitudes de la colección pasan por la misma API que su aplicación en producción: se aplican las mismas reglas de seguridad.
- Todas las solicitudes transitan en HTTPS/TLS 1.2 como mínimo.
- Cada clave API está limitada a los permisos que le otorga en su creación.
- Utilice una clave de prueba dedicada para sus ensayos en Postman, distinta de su clave de producción.
- Una clave API comprometida o no utilizada se revoca en un clic desde su panel de Certyneo.
Preguntas frecuentes
¿Se necesita un plan pagado para utilizar la colección Postman?
No. La colección es pública y gratuita. Los límites de tu plan Certyneo (número de sobres, funcionalidades) se aplican a las solicitudes ejecutadas, como para cualquier uso de la API.
¿Dónde encontrar mi clave API?
En tu panel de control Certyneo, en Parámetros → Claves API. Crea una clave dedicada a tus pruebas de Postman.
¿Está la colección actualizada con la última versión de la API?
Sí, la colección se regenera desde la especificación OpenAPI oficial de la API Certyneo en cada evolución de la API REST v1.
¿Puedo probar webhooks desde Postman?
Sí, la colección contiene los endpoints para crear y listar tus suscripciones de webhooks. Para recibir eventos en local, utiliza un servicio de túnel HTTP durante tus pruebas.
¿El uso de la colección de Postman tiene costo?
No, solo el consumo de la API misma (creación de sobres) se descuenta de tu plan, exactamente como una llamada API clásica.
Para ir más allá
Prueba la API Certyneo en Postman
Colección pública, gratuita, sincronizada con nuestra documentación para desarrolladores.