Inicio rápido
Integra AllSign en tu aplicación en menos de 5 minutos. Esta guía te llevará desde la configuración inicial hasta tu primera firma electrónica.
Paso 1: Obtén tu API key
Antes de comenzar, necesitas tu clave de API:
- Accede al Dashboard de AllSign
- Ve a Subscription y contrata una suscripción
- Con tu suscripción activa, agrega el complemento ApiRest para habilitar el acceso a la API
- Una vez activado el complemento, se habilitará la sección API Keys donde podrás generar tus claves
- Genera tu primera API key y guarda la clave (formato:
allsign_live_sk_xxx)
Tu API key se muestra solo una vez al crearla. Guárdala en un lugar seguro.
Para desarrollo usa el ambiente test, para producción usa live.
Paso 2: Verifica tu API key
Antes de continuar, verifica que tu API key funciona correctamente:
curl "https://api.allsign.io/v2/test/security" \
-H "Authorization: Bearer allsign_live_sk_TU_API_KEY_AQUI"
Respuesta exitosa:
{
"success": true,
"message": "API V2 security validated successfully",
"authenticatedUser": "tu@email.com",
"tenantId": "550e8400-e29b-41d4-a716-446655440000",
"scopes": ["document:read", "document:write"],
"environment": "live"
}
Si recibes un error 401 Unauthorized, verifica que tu API key esté correcta y que el formato sea Authorization: Bearer allsign_live_sk_xxx.
Paso 3: Listar tus documentos
Una vez verificada tu API key, ya puedes interactuar con la API. Empecemos listando documentos:
curl "https://api.allsign.io/v2/documents" \
-H "Authorization: Bearer allsign_live_sk_TU_API_KEY_AQUI"
Respuesta esperada:
{
"success": true,
"data": [],
"message": "Documents retrieved successfully"
}
Paso 4: Crear tu primer documento
Ahora vamos a subir un documento para firma:
curl -X POST "https://api.allsign.io/v2/documents" \
-H "Authorization: Bearer allsign_live_sk_TU_API_KEY_AQUI" \
-H "Content-Type: multipart/form-data" \
-F "file=@/ruta/a/tu/documento.pdf" \
-F "document_name=Mi primer documento" \
-F "description=Documento de prueba para firma electrónica"
Respuesta exitosa:
{
"success": true,
"data": {
"id": "doc_abc123",
"name": "Mi primer documento",
"status": "draft",
"created_at": "2024-01-15T10:30:00Z"
}
}
Próximos pasos
¡Perfecto! Ya tienes AllSign configurado y funcionando. Aquí tienes los siguientes pasos para una integración completa:
Flujo completo de firma
- Crear documento - Sube archivos PDF para firma
- Añadir participantes - Invita firmantes al documento
- Configurar campos - Define dónde van las firmas
- Enviar para firma - Inicia el proceso de firma
- Monitorear estado - Recibe notificaciones de cambios
Recursos útiles
- Autenticación - Configuración de API keys y seguridad
- Manejo de errores - Códigos de error y soluciones
- Webhooks - Notificaciones en tiempo real
- SDKs - Librerías para diferentes lenguajes
¿Necesitas ayuda?
- Documentación completa - Explora todos los endpoints disponibles
- Ejemplos de código - Casos de uso comunes implementados
- Soporte técnico - Contacta nuestro equipo para ayuda personalizada

